BackendAuthenticatorApi Interface Reference

This API is used for accessing current state of Authenticator for backend services from client game. More...

Static Public Member Functions
static proto bool	IsEnabled ()
	Return true if authentication with backend is enabled.
static proto bool	IsAuthInProgress ()
	Returns true if we are currently attempting to newly authenticate or refresh authentication of client.
static proto bool	IsAuthenticated ()
	Returns true if client is currently authenticated with backend and online services can be accessed.
static proto UUID	GetIdentityId ()
	Returns Identity Id of locally authenticated user.

Detailed Description

This API is used for accessing current state of Authenticator for backend services from client game.

Authentication is handled in background during entire lifetime of application if it is enabled.

Note

This API is only intended for client game and will always be disabled on Dedicated Server which. Server use different authentication which uses different API (TBD). Listen Server which is running on client would use both this and server auth APIs.

Member Function Documentation

GetIdentityId()

static proto UUID BackendAuthenticatorApi.GetIdentityId ( )

static

Returns Identity Id of locally authenticated user.

User has to be at least once authenticated to receive ID.

Note

On Dedicated servers this value will be always Null.

IsAuthenticated()

static proto bool BackendAuthenticatorApi.IsAuthenticated ( )

static

Returns true if client is currently authenticated with backend and online services can be accessed.

IsAuthInProgress()

static proto bool BackendAuthenticatorApi.IsAuthInProgress ( )

static

Returns true if we are currently attempting to newly authenticate or refresh authentication of client.

Note

This can be true even when already authenticated because we can currently be refreshing authentication.

IsEnabled()

static proto bool BackendAuthenticatorApi.IsEnabled ( )

static

Return true if authentication with backend is enabled.

False if disabled.

Note

Disabled state can be interpreted as signed out state when we are not attempting to reconnect or sign in. Online services which require authentication will not be accessible in this state. State of authentication is set by platform service which determines if user is signed in or not.

---

The documentation for this interface was generated from the following file:

• GameLib/generated/online/BackendAuthenticatorApi.c