public class EOS_UserInfo_Interface
extends com.sun.jna.PointerType
EOS_Platform_Interface.getUserInfoInterface()| Constructor and Description |
|---|
EOS_UserInfo_Interface() |
EOS_UserInfo_Interface(com.sun.jna.Pointer address) |
| 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.
|
public EOS_UserInfo_Interface(com.sun.jna.Pointer address)
public EOS_UserInfo_Interface()
public void queryUserInfo(EOS_UserInfo_QueryUserInfoOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoCallback completionDelegate)
options - structure containing the input parametersclientData - arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - a callback that is fired when the async operation completes, either successfully or in errorEOS_UserInfo,
copyUserInfo(EOS_UserInfo_CopyUserInfoOptions),
EOS_UserInfo_QueryUserInfoOptions,
EOS_UserInfo_OnQueryUserInfoCallbackpublic void queryUserInfoByDisplayName(EOS_UserInfo_QueryUserInfoByDisplayNameOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback completionDelegate)
options - structure containing the input parametersclientData - arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - a callback that is fired when the async operation completes, either successfully or in errorEOS_UserInfo,
copyUserInfo(EOS_UserInfo_CopyUserInfoOptions),
EOS_UserInfo_QueryUserInfoByDisplayNameOptions,
EOS_UserInfo_OnQueryUserInfoByDisplayNameCallbackpublic void queryUserInfoByExternalAccount(EOS_UserInfo_QueryUserInfoByExternalAccountOptions options, com.sun.jna.Pointer clientData, EOS_UserInfo_OnQueryUserInfoByExternalAccountCallback completionDelegate)
options - structure containing the input parametersclientData - arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - a callback that is fired when the async operation completes, either successfully or in errorEOS_UserInfo,
EOS_UserInfo_QueryUserInfoByExternalAccountOptions,
EOS_UserInfo_OnQueryUserInfoByExternalAccountCallbackpublic EOS_UserInfo copyUserInfo(EOS_UserInfo_CopyUserInfoOptions options) throws EOSException
options - structure containing the input parametersEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSIncompatibleVersionException - if the API version passed in is incorrectEOSNotFoundException - if the user info is not locally cached. The information must have been previously cached by a call to EOS_UserInfo_QueryUserInfoEOSExceptionEOS_UserInfo,
EOS_UserInfo_CopyUserInfoOptions,
EOS_UserInfo.release()public int getExternalUserInfoCount(EOS_UserInfo_GetExternalUserInfoCountOptions options)
options - The options associated with retrieving the external user info countcopyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions)public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByIndex(EOS_UserInfo_CopyExternalUserInfoByIndexOptions options) throws EOSException
options - Structure containing the index being accessedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the external user info is not foundEOSExceptionEOS_UserInfo_ExternalUserInfo.release()public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByAccountType(EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions options) throws EOSException
options - Structure containing the account type being accessedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the external user info is not foundEOSExceptionEOS_UserInfo_ExternalUserInfo.release()public EOS_UserInfo_ExternalUserInfo copyExternalUserInfoByAccountId(EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions options) throws EOSException
options - Structure containing the account ID being accessedEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the external user info is not foundEOSExceptionEOS_UserInfo_ExternalUserInfo.release()public EOS_UserInfo_BestDisplayName copyBestDisplayName(EOS_UserInfo_CopyBestDisplayNameOptions options) throws EOSException
options - structure containing the input parametersEOSUserInfoBestDisplayNameIndeterminateException - 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 detailsEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if the user info or product user id is not locally cachedEOSExceptionqueryUserInfo(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()public EOS_UserInfo_BestDisplayName copyBestDisplayNameWithPlatform(EOS_UserInfo_CopyBestDisplayNameWithPlatformOptions options) throws EOSException
options - structure containing the input parametersEOSUserInfoBestDisplayNameIndeterminateException - unable to determine a cert friendly display name for userEOSInvalidParametersException - if you pass a null pointer for the out parameterEOSIncompatibleVersionException - if the API version passed in is incorrectEOSNotFoundException - if the user info is not locally cachedEOSExceptionqueryUserInfo(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()public EOS_OnlinePlatformType getLocalPlatformType(EOS_UserInfo_GetLocalPlatformTypeOptions options)
options - structure containing the input parametersEOS_UserInfo_GetLocalPlatformTypeOptions