host.anzo.eossdk.eos.sdk

Class EOS_IntegratedPlatform_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_IntegratedPlatform_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_IntegratedPlatform_Interface
extends com.sun.jna.PointerType

To add integrated platforms, you must call EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer to create an integrated platform options container. To modify that handle, call EOS_IntegratedPlatformOptionsContainer_* methods. Once you are finished, call EOS_Platform_Create with your handle. You must then release your integrated platform options container handle by calling EOS_IntegratedPlatformOptionsContainer_Release.

Since:

8/20/2023

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EOS_NotificationId	addNotifyUserLoginStatusChanged(EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions options, com.sun.jna.Pointer clientData, EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback callbackFunction) Register to receive notifications when the login state of Integrated Platform users change.
void	clearUserPreLogoutCallback(EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions options) Clears a previously set integrated platform user logout handler for the specified integrated platform.
EOS_EResult	createIntegratedPlatformOptionsContainer(EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainerOptions options, EOS_IntegratedPlatformOptionsContainer outIntegratedPlatformOptionsContainerHandle) Creates an integrated platform options container handle.
EOS_EResult	finalizeDeferredUserLogout(EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions options) Complete a Logout/Login for a previously deferred Integrated Platform User Logout.
void	removeNotifyUserLoginStatusChanged(EOS_NotificationId notificationId) Unregister from Integrated Platform user login and logout notifications.
EOS_EResult	setUserLoginStatus(EOS_IntegratedPlatform_SetUserLoginStatusOptions options) Sets the current login status of a specific local platform user to a new value.
EOS_EResult	setUserPreLogoutCallback(EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions options, com.sun.jna.Pointer clientData, EOS_IntegratedPlatform_OnUserPreLogoutCallback callbackFunction) Sets the integrated platform user logout handler for all integrated platforms.

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_IntegratedPlatform_Interface

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

EOS_IntegratedPlatform_Interface

public EOS_IntegratedPlatform_Interface()

Method Detail

createIntegratedPlatformOptionsContainer

public EOS_EResult createIntegratedPlatformOptionsContainer(EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainerOptions options,
                                                            EOS_IntegratedPlatformOptionsContainer outIntegratedPlatformOptionsContainerHandle)

Creates an integrated platform options container handle. This handle can used to add multiple options to your container which will then be applied with EOS_Platform_Create. The resulting handle must be released by calling EOS_IntegratedPlatformOptionsContainer_Release once it has been passed to EOS_Platform_Create.

Parameters:

options - structure containing operation input parameters.

outIntegratedPlatformOptionsContainerHandle - Pointer to an integrated platform options container handle to be set if successful.

Returns:

Success if we successfully created the integrated platform options container handle pointed at in OutIntegratedPlatformOptionsContainerHandle, or an error result if the input data was invalid.

See Also:

EOS_IntegratedPlatformOptionsContainer.release(), EOS.EOS_Platform_Create(EOS_Platform_Options), EOS_IntegratedPlatformOptionsContainer.add(EOS_IntegratedPlatformOptionsContainer_AddOptions)

setUserLoginStatus

public EOS_EResult setUserLoginStatus(EOS_IntegratedPlatform_SetUserLoginStatusOptions options)

Sets the current login status of a specific local platform user to a new value.

This function may only be used with an Integrated Platform initialized with the EOS_IPMF_ApplicationManagedIdentityLogin flag, otherwise calls will return EOS_InvalidState and a platform user's login status will be controlled by OS events.

If the login status of a user changes, a Integrated Platform User Login Status Changed notification will fire, and depending on the state of the user's login and the platform, the EOS SDK might start fetching data for the user, it may clear cached data, or it may do nothing.

If the login status of a user is not different from a previous call to this function, the function will do nothing and return EOS_Success. This will not trigger a call to the Integrated Platform User Login Status Changed.

Parameters:

options - options

Returns:

EOS_EResult.EOS_Success if the call was successful
EOS_EResult.EOS_NotConfigured if the Integrated Platform was not initialized on platform creation
EOS_EResult.EOS_InvalidState if the Integrated Platform was not initialized with the EOS_IPMF_ApplicationManagedIdentityLogin flag
EOS_EResult.EOS_InvalidUser if the LocalPlatformUserId is not a valid user id for the provided Integrated Platform
EOS_EResult.EOS_InvalidParameters if any other input was invalid

addNotifyUserLoginStatusChanged

public EOS_NotificationId addNotifyUserLoginStatusChanged(EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions options,
                                                          com.sun.jna.Pointer clientData,
                                                          EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback callbackFunction)

Register to receive notifications when the login state of Integrated Platform users change.

This notification will trigger any time the EOS SDK's internal login state changes for a user, including for manual login state changes (when the EOS_IPMF_ApplicationManagedIdentityLogin flag is set), or automatically detected ones (when not disabled by the EOS_IPMF_ApplicationManagedIdentityLogin flag).

Parameters:

options - Data associated with what version of the notification to receive.

clientData - A context pointer that is returned in the callback function.

callbackFunction - The function that is called when Integrated Platform user logins happen

Returns:

A valid notification that can be used to unregister for notifications, or EOS_INVALID_NOTIFICATIONID if input was invalid.

See Also:

removeNotifyUserLoginStatusChanged(EOS_NotificationId)

removeNotifyUserLoginStatusChanged

public void removeNotifyUserLoginStatusChanged(EOS_NotificationId notificationId)

Unregister from Integrated Platform user login and logout notifications.

Parameters:

notificationId - The NotificationId that was returned from registering for Integrated Platform user login and logout notifications.

See Also:

addNotifyUserLoginStatusChanged(EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions, Pointer, EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback)

setUserPreLogoutCallback

public EOS_EResult setUserPreLogoutCallback(EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions options,
                                            com.sun.jna.Pointer clientData,
                                            EOS_IntegratedPlatform_OnUserPreLogoutCallback callbackFunction)

Sets the integrated platform user logout handler for all integrated platforms.

There can only be one handler set at once, attempting to set a handler when one is already set will result in a EOS_AlreadyConfigured error.

This callback handler allows applications to decide if a user is logged-out immediately when the SDK receives a system user logout event, or if the application would like to give the user a chance to correct themselves and log back in if they are in a state that might be disruptive if an accidental logout happens (unsaved user data, in a multiplayer match, etc). This is not supported on all integrated platforms, such as those where applications automatically close when a user logs out, or those where a user is always logged-in.

If a logout is deferred, applications are expected to eventually call EOS_IntegratedPlatform_FinalizeDeferredUserLogout when they have decided a user meant to logout, or if they have logged in again.

Parameters:

options - Data that specifies the API version.

clientData - An optional context pointer that is returned in the callback data.

callbackFunction - The function that will handle the callback.

Returns:

EOS_EResult.EOS_Success if the platform user logout handler was bound successfully.
EOS_EResult.EOS_AlreadyConfigured if there is already a platform user logout handler bound.

See Also:

clearUserPreLogoutCallback(EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions), finalizeDeferredUserLogout(EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions)

clearUserPreLogoutCallback

public void clearUserPreLogoutCallback(EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions options)

Clears a previously set integrated platform user logout handler for the specified integrated platform. If none is set for the specified platform, this does nothing.

If there are any pending deferred user-logouts when a handler is cleared, those users will internally be logged-out and cached data about those users cleared before this function returns. Any applicable callbacks about those users being logged-out will occur in a future call to EOS_Platform_Tick().

Parameters:

options - Data for which integrated platform to no longer call a previously-registered callback for.

See Also:

setUserPreLogoutCallback(EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions, Pointer, EOS_IntegratedPlatform_OnUserPreLogoutCallback)

finalizeDeferredUserLogout

public EOS_EResult finalizeDeferredUserLogout(EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions options)

Complete a Logout/Login for a previously deferred Integrated Platform User Logout.

This function allows applications to control whether an integrated-platform user actually logs out when an integrated platform's system tells the SDK a user has been logged-out. This allows applications to prevent accidental logouts from destroying application user state. If a user did not mean to logout, the application should prompt and confirm whether the user meant to logout, and either wait for them to confirm they meant to, or wait for them to login again, before calling this function.

If the sign-out is intended and your application believes the user is still logged-out, the UserExpectedLoginState in Options should be EOS_LS_NotLoggedIn. If the sign-out was NOT intended and your application believes the user has logged-in again, the UserExpectedLoginState in Options should be EOS_LS_LoggedIn.

Parameters:

options - Data for which integrated platform and user is now in the expected logged-in/logged-out state.

Returns:

EOS_EResult.EOS_Success if the platform user state matches the UserExpectedLoginState internally.
EOS_EResult.EOS_NotConfigured if the Integrated Platform was not initialized on platform creation
EOS_EResult.EOS_InvalidUser if the LocalPlatformUserId is not a valid user id for the provided Integrated Platform, or if there is no deferred logout waiting to be completed for this specified user
EOS_EResult.EOS_InvalidParameters if any other input was invalid

See Also:

setUserPreLogoutCallback(EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions, Pointer, EOS_IntegratedPlatform_OnUserPreLogoutCallback), clearUserPreLogoutCallback(EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions), addNotifyUserLoginStatusChanged(EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions, Pointer, EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback)