host.anzo.eossdk.eos.sdk

Class EOS_UserInfo_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_UserInfo_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_UserInfo_Interface
extends com.sun.jna.PointerType

The UserInfo Interface is used to receive user information for Epic Account IDs from the backend services and to retrieve that information once it is cached. All UserInfo Interface calls take a handle of type EOS_UserInfo as the first parameter. This handle can be retrieved from a EOS_Platform handle by using the EOS_Platform_GetUserInfoInterface function.

Since:

9/3/2023

See Also:

EOS_Platform_Interface.getUserInfoInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_UserInfo_Interface()
EOS_UserInfo_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_UserInfo_BestDisplayName	copyBestDisplayName(EOS_UserInfo_CopyBestDisplayNameOptions options) EOS_UserInfo_CopyBestDisplayName is used to immediately retrieve a copy of user's best display name based on an Epic Account ID.
EOS_UserInfo_BestDisplayName	copyBestDisplayNameWithPlatform(EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions options) EOS_UserInfo_CopyBestDisplayNameWithPlatform is used to immediately retrieve a copy of user's best display name based on an Epic Account ID.
EOS_UserInfo_ExternalUserInfo	copyExternalUserInfoByAccountId(EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions options) Fetches an external user info for a given external account ID.
EOS_UserInfo_ExternalUserInfo	copyExternalUserInfoByAccountType(EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions options) Fetches an external user info for a given external account type.
EOS_UserInfo_ExternalUserInfo	copyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions options) Fetches an external user info from a given index.
EOS_UserInfo	copyUserInfo(EOS_UserInfo_CopyUserInfoOptions options) EOS_UserInfo_CopyUserInfo is used to immediately retrieve a copy of user information based on an Epic Account ID, cached by a previous call to EOS_UserInfo_QueryUserInfo.
int	getExternalUserInfoCount(EOS_UserInfo_GetExternalUserInfoCountOptions options) Fetch the number of external user infos that are cached locally.
EOS_OnlinePlatformType	getLocalPlatformType(EOS_UserInfo_GetLocalPlatformTypeOptions options) EOS_UserInfo_GetLocalPlatformType is used to retrieve the online platform type of the current running instance of the game.
void	queryUserInfo(EOS_UserInfo_QueryUserInfoOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoCallback completionDelegate) EOS_UserInfo_QueryUserInfo is used to start an asynchronous query to retrieve information, such as display name, about another account.
void	queryUserInfoByDisplayName(EOS_UserInfo_QueryUserInfoByDisplayNameOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback completionDelegate) EOS_UserInfo_QueryUserInfoByDisplayName is used to start an asynchronous query to retrieve user information by display name.
void	queryUserInfoByExternalAccount(EOS_UserInfo_QueryUserInfoByExternalAccountOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback completionDelegate) EOS_UserInfo_QueryUserInfoByExternalAccount is used to start an asynchronous query to retrieve user information by external accounts.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_UserInfo_Interface

public EOS_UserInfo_Interface(com.sun.jna.Pointer address)

EOS_UserInfo_Interface

public EOS_UserInfo_Interface()

Method Detail

queryUserInfo

public void queryUserInfo(EOS_UserInfo_QueryUserInfoOptions options,
                          com.sun.jna.Pointer clientData,
                          EOS_UserInfo_OnQueryUserInfoCallback completionDelegate)

EOS_UserInfo_QueryUserInfo is used to start an asynchronous query to retrieve information, such as display name, about another account. Once the callback has been fired with a successful ResultCode, it is possible to call EOS_UserInfo_CopyUserInfo to receive an EOS_UserInfo containing the available information.

Parameters:

options - structure containing the input parameters

clientData - arbitrary data that is passed back to you in the completionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

See Also:

EOS_UserInfo, copyUserInfo(EOS_UserInfo_CopyUserInfoOptions), EOS_UserInfo_QueryUserInfoOptions, EOS_UserInfo_OnQueryUserInfoCallback

queryUserInfoByDisplayName

public void queryUserInfoByDisplayName(EOS_UserInfo_QueryUserInfoByDisplayNameOptions options,
                                       com.sun.jna.Pointer clientData,
                                       EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback completionDelegate)

EOS_UserInfo_QueryUserInfoByDisplayName is used to start an asynchronous query to retrieve user information by display name. This can be useful for getting the EOS_EpicAccountId for a display name. Once the callback has been fired with a successful ResultCode, it is possible to call EOS_UserInfo_CopyUserInfo to receive an EOS_UserInfo containing the available information.

Parameters:

options - structure containing the input parameters

clientData - arbitrary data that is passed back to you in the completionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

See Also:

EOS_UserInfo, copyUserInfo(EOS_UserInfo_CopyUserInfoOptions), EOS_UserInfo_QueryUserInfoByDisplayNameOptions, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback

queryUserInfoByExternalAccount

public void queryUserInfoByExternalAccount(EOS_UserInfo_QueryUserInfoByExternalAccountOptions options,
                                           com.sun.jna.Pointer clientData,
                                           EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback completionDelegate)

EOS_UserInfo_QueryUserInfoByExternalAccount is used to start an asynchronous query to retrieve user information by external accounts. This can be useful for getting the EOS_EpicAccountId for external accounts. Once the callback has been fired with a successful ResultCode, it is possible to call CopyUserInfo to receive an EOS_UserInfo containing the available information.

Parameters:

options - structure containing the input parameters

clientData - arbitrary data that is passed back to you in the completionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

See Also:

EOS_UserInfo, EOS_UserInfo_QueryUserInfoByExternalAccountOptions, EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback

copyUserInfo

public EOS_UserInfo copyUserInfo(EOS_UserInfo_CopyUserInfoOptions options)
                          throws EOSException

EOS_UserInfo_CopyUserInfo is used to immediately retrieve a copy of user information based on an Epic Account ID, cached by a previous call to EOS_UserInfo_QueryUserInfo. If the call returns an EOS_Success result, the out parameter, OutUserInfo, must be passed to EOS_UserInfo_Release to release the memory associated with it.

Parameters:

options - structure containing the input parameters

Returns:

out parameter used to receive the EOS_UserInfo structure.

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSNotFoundException - if the user info is not locally cached. The information must have been previously cached by a call to EOS_UserInfo_QueryUserInfo

EOSException

See Also:

EOS_UserInfo, EOS_UserInfo_CopyUserInfoOptions, EOS_UserInfo.release()

getExternalUserInfoCount

public int getExternalUserInfoCount(EOS_UserInfo_GetExternalUserInfoCountOptions options)

Fetch the number of external user infos that are cached locally.

Parameters:

options - The options associated with retrieving the external user info count

Returns:

The number of external user infos, or 0 if there is an error

See Also:

copyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions)

copyExternalUserInfoByIndex

public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions options)
                                                          throws EOSException

Fetches an external user info from a given index.

Parameters:

options - Structure containing the index being accessed

Returns:

The external user info. If it exists and is valid, use EOS_UserInfo_ExternalUserInfo_Release when finished

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the external user info is not found

EOSException

See Also:

EOS_UserInfo_ExternalUserInfo.release()

copyExternalUserInfoByAccountType

public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByAccountType(EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions options)
                                                                throws EOSException

Fetches an external user info for a given external account type.

Parameters:

options - Structure containing the account type being accessed

Returns:

The external user info. If it exists and is valid, use EOS_UserInfo_ExternalUserInfo_Release when finished

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the external user info is not found

EOSException

See Also:

EOS_UserInfo_ExternalUserInfo.release()

copyExternalUserInfoByAccountId

public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByAccountId(EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions options)
                                                              throws EOSException

Fetches an external user info for a given external account ID.

Parameters:

options - Structure containing the account ID being accessed

Returns:

The external user info. If it exists and is valid, use EOS_UserInfo_ExternalUserInfo_Release when finished

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the external user info is not found

EOSException

See Also:

EOS_UserInfo_ExternalUserInfo.release()

copyBestDisplayName

public EOS_UserInfo_BestDisplayName copyBestDisplayName(EOS_UserInfo_CopyBestDisplayNameOptions options)
                                                 throws EOSException

EOS_UserInfo_CopyBestDisplayName is used to immediately retrieve a copy of user's best display name based on an Epic Account ID. This uses data cached by a previous call to EOS_UserInfo_QueryUserInfo, EOS_UserInfo_QueryUserInfoByDisplayName or EOS_UserInfo_QueryUserInfoByExternalAccount as well as EOS_Connect_QueryExternalAccountMappings. If the call returns an EOS_Success result, the out parameter, outBestDisplayName, must be passed to EOS_UserInfo_BestDisplayName_Release to release the memory associated with it.

The current priority for picking display name is as follows:

• 1. Target is online and friends with user, then use presence platform to determine display name
• 2. Target is in same lobby or is the owner of a lobby search result, then use lobby platform to determine display name (this requires the target's product user id to be cached)
• 3. Target is in same rtc room, then use rtc room platform to determine display name (this requires the target's product user id to be cached)

Parameters:

options - structure containing the input parameters

Returns:

out parameter used to receive the EOS_UserInfo_BestDisplayName structure.

Throws:

EOSUserInfoBestDisplayNameIndeterminateException - unable to determine a cert friendly display name for user, one potential solution would be to call EOS_UserInfo_CopyBestDisplayNameWithPlatform with EOS_OPT_Epic for the platform, see doc for more details

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the user info or product user id is not locally cached

EOSException

See Also:

queryUserInfo(EOS_UserInfo_QueryUserInfoOptions, Pointer, EOS_UserInfo_OnQueryUserInfoCallback), queryUserInfoByDisplayName(EOS_UserInfo_QueryUserInfoByDisplayNameOptions, Pointer, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback), queryUserInfoByExternalAccount(EOS_UserInfo_QueryUserInfoByExternalAccountOptions, Pointer, EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback), EOS_Connect_Interface.queryExternalAccountMappings(EOS_Connect_QueryExternalAccountMappingsOptions, Pointer, EOS_Connect_OnQueryExternalAccountMappingsCallback), copyBestDisplayNameWithPlatform(EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions), EOS_UserInfo_CopyBestDisplayNameOptions, EOS_UserInfo_BestDisplayName, EOS_UserInfo_BestDisplayName.release()

copyBestDisplayNameWithPlatform

public EOS_UserInfo_BestDisplayName copyBestDisplayNameWithPlatform(EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions options)
                                                             throws EOSException

EOS_UserInfo_CopyBestDisplayNameWithPlatform is used to immediately retrieve a copy of user's best display name based on an Epic Account ID. This uses data cached by a previous call to EOS_UserInfo_QueryUserInfo, EOS_UserInfo_QueryUserInfoByDisplayName or EOS_UserInfo_QueryUserInfoByExternalAccount. If the call returns an EOS_Success result, the out parameter, outBestDisplayName, must be passed to EOS_UserInfo_BestDisplayName_Release to release the memory associated with it.

The current priority for picking display name is as follows:

• 1. If platform is non-epic, then use platform display name (if the platform is linked to the account)
• 2. If platform is epic and user has epic display name, then use epic display name
• 3. If platform is epic and user has no epic display name, then use linked external account display name

Parameters:

options - structure containing the input parameters

Returns:

out parameter used to receive the EOS_UserInfo_BestDisplayName structure.

Throws:

EOSUserInfoBestDisplayNameIndeterminateException - unable to determine a cert friendly display name for user

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSNotFoundException - if the user info is not locally cached

EOSException

See Also:

queryUserInfo(EOS_UserInfo_QueryUserInfoOptions, Pointer, EOS_UserInfo_OnQueryUserInfoCallback), queryUserInfoByDisplayName(EOS_UserInfo_QueryUserInfoByDisplayNameOptions, Pointer, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback), queryUserInfoByExternalAccount(EOS_UserInfo_QueryUserInfoByExternalAccountOptions, Pointer, EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback), EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions, EOS_UserInfo_BestDisplayName, EOS_UserInfo_BestDisplayName.release()

getLocalPlatformType

public EOS_OnlinePlatformType getLocalPlatformType(EOS_UserInfo_GetLocalPlatformTypeOptions options)

EOS_UserInfo_GetLocalPlatformType is used to retrieve the online platform type of the current running instance of the game.

Parameters:

options - structure containing the input parameters

Returns:

the online platform type of the current running instance of the game

See Also:

EOS_UserInfo_GetLocalPlatformTypeOptions