FUserOnlineAccountAccelByte Class Reference

Info associated with an user account generated by AccelByte online service. More...

#include <OnlineSubsystemAccelByteTypes.h>

Inheritance diagram for FUserOnlineAccountAccelByte:

Public Member Functions
	FUserOnlineAccountAccelByte (const FString &InUserId=TEXT(""))
	FUserOnlineAccountAccelByte (const TSharedRef< const FUniqueNetId > &InUserId)
	FUserOnlineAccountAccelByte (const TSharedRef< const FUniqueNetId > &InUserId, const FString &InDisplayName)
	FUserOnlineAccountAccelByte (const FAccelByteUniqueIdComposite &InCompositeId)
virtual TSharedRef< const FUniqueNetId >	GetUserId () const override
virtual FString	GetRealName () const override
virtual FString	GetDisplayName (const FString &Platform=FString()) const override
virtual bool	GetUserAttribute (const FString &AttrName, FString &OutAttrValue) const override
virtual bool	SetUserLocalAttribute (const FString &AttrName, const FString &InAttrValue) override
virtual FString	GetAccessToken () const override
virtual bool	SetUserAttribute (const FString &AttrName, const FString &AttrValue) override
virtual bool	GetAuthAttribute (const FString &AttrName, FString &OutAttrValue) const override
FString	GetPublicCode ()
	Get user's PublicCode on AccelByte services.
void	SetDisplayName (const FString &InDisplayName)
	Set user's display name on AccelByte services.
void	SetUniqueDisplayName (const FString &InUniqueDisplayName)
	Set user's unique display name on AccelByte services.
FString	GetUserCountry () const
	Get user's country on AccelByte services.
void	SetUserCountry (const FString &InUserCountry)
	Set user's country on AccelByte services.
void	SetCredentialsRef (AccelByte::FBaseCredentialsRef InCredentialsRef)
	Set Credentials Ref.
void	SetPublicCode (const FString &InPublicCode)
	Set user's PublicCode on AccelByte services.
FString	GetPlatformUserId () const
	Get Platform User ID from AccelByte services.
void	SetPlatformUserId (const FString &InPlatformUserId)
	Set Platform User ID, set on OnLoginSuccess Handler.
FString	GetSimultaneousPlatformID () const
	Get Simultaneous Platform ID from AccelByte services.
void	SetSimultaneousPlatformID (const FString &InSimultaneousPlatformID)
	Set Simultaneous Platform ID, set on OnLoginSuccess Handler.
FString	GetSimultaneousPlatformUserID () const
	Get Simultaneous Platform User ID from AccelByte services.
void	SetSimultaneousPlatformUserID (const FString &InSimultaneousPlatformUserID)
	Set Simultaneous Platform User ID, set on OnLoginSuccess Handler.
bool	IsConnectedToLobby () const
	A flag that indicates whether the user is connected to AccelByte Lobby or not.
void	SetConnectedToLobby (bool bIsConnected)
	Set user's connected status to AccelByte Lobby.
bool	IsConnectedToChat () const
	A flag that indicates whether the user is connected to AccelByte Chat or not.
void	SetConnectedToChat (bool bIsConnected)
	Set user's connected status to AccelByte Chat.
void	AddPlatformUser (const FOnlinePlatformUserAccelByte &PlatformUser)
const FOnlinePlatformUserAccelByte *	GetPlatformUser (const FString &PlatformId) const

Detailed Description

Info associated with an user account generated by AccelByte online service.

Member Function Documentation

AddPlatformUser()

void FUserOnlineAccountAccelByte::AddPlatformUser

(

const FOnlinePlatformUserAccelByte &

PlatformUser

)

Adds a new platform user's information to the account. This method is used to store platform-specific information such as the user's display name, avatar URL, and platform identifiers within the account. It's essential for managing multiple platform identities linked to a single user account.

Parameters

PlatformUser

An instance of FOnlinePlatformUserAccelByte containing the user's platform-specific information.

GetPlatformUser()

const FOnlinePlatformUserAccelByte * FUserOnlineAccountAccelByte::GetPlatformUser

(

const FString &

PlatformId

)

const

Retrieves platform user information based on the given platform ID. Returns a pointer to the platform user's information if found, otherwise null.

Parameters

PlatformId

The unique identifier of the platform user.

Returns

A pointer to the FOnlinePlatformUserAccelByte object, or nullptr if not found.

GetPlatformUserId()

FString FUserOnlineAccountAccelByte::GetPlatformUserId

(

)

const

Get Platform User ID from AccelByte services.

Returns

The user's PublicCode

GetPublicCode()

FString FUserOnlineAccountAccelByte::GetPublicCode

(

)

Get user's PublicCode on AccelByte services.

Returns

The user's PublicCode

GetSimultaneousPlatformID()

FString FUserOnlineAccountAccelByte::GetSimultaneousPlatformID

(

)

const

Get Simultaneous Platform ID from AccelByte services.

Returns

The user's Simultaneous Platform ID

GetSimultaneousPlatformUserID()

FString FUserOnlineAccountAccelByte::GetSimultaneousPlatformUserID

(

)

const

Get Simultaneous Platform User ID from AccelByte services.

Returns

The user's Simultaneous Platform User ID

GetUserCountry()

FString FUserOnlineAccountAccelByte::GetUserCountry

(

)

const

Get user's country on AccelByte services.

Returns

The user's UserCountry

IsConnectedToChat()

bool FUserOnlineAccountAccelByte::IsConnectedToChat

(

)

const

A flag that indicates whether the user is connected to AccelByte Chat or not.

Returns

bool Return connected status, true for connected and false for not connected

IsConnectedToLobby()

bool FUserOnlineAccountAccelByte::IsConnectedToLobby

(

)

const

A flag that indicates whether the user is connected to AccelByte Lobby or not.

Returns

bool Return connected status, true for connected and false for not connected

SetConnectedToChat()

void FUserOnlineAccountAccelByte::SetConnectedToChat

(

bool

bIsConnected

)

Set user's connected status to AccelByte Chat.

Parameters

bIsConnected

connected status, true for connected and false for not connected

SetConnectedToLobby()

void FUserOnlineAccountAccelByte::SetConnectedToLobby

(

bool

bIsConnected

)

Set user's connected status to AccelByte Lobby.

Parameters

bIsConnected

connected status, true for connected and false for not connected

SetCredentialsRef()

void FUserOnlineAccountAccelByte::SetCredentialsRef

(

AccelByte::FBaseCredentialsRef

InCredentialsRef

)

Set Credentials Ref.

Parameters

InCredentialsRef

The user's ApiClient::CredentialsRef

SetDisplayName()

void FUserOnlineAccountAccelByte::SetDisplayName

(

const FString &

InDisplayName

)

Set user's display name on AccelByte services.

Parameters

InDisplayName

The user's display name

SetPlatformUserId()

void FUserOnlineAccountAccelByte::SetPlatformUserId

(

const FString &

InPlatformUserId

)

Set Platform User ID, set on OnLoginSuccess Handler.

Parameters

InPlatformUserId

The Platform User ID

SetPublicCode()

void FUserOnlineAccountAccelByte::SetPublicCode

(

const FString &

InPublicCode

)

Set user's PublicCode on AccelByte services.

Parameters

InPublicCode

The user's PublicCode

SetSimultaneousPlatformID()

void FUserOnlineAccountAccelByte::SetSimultaneousPlatformID

(

const FString &

InSimultaneousPlatformID

)

Set Simultaneous Platform ID, set on OnLoginSuccess Handler.

Parameters

InSimultaneousPlatformID

The Simultaneous Platform ID

SetSimultaneousPlatformUserID()

void FUserOnlineAccountAccelByte::SetSimultaneousPlatformUserID

(

const FString &

InSimultaneousPlatformUserID

)

Set Simultaneous Platform User ID, set on OnLoginSuccess Handler.

Parameters

InSimultaneousPlatformUserID

The Simultaneous Platform User ID

SetUniqueDisplayName()

void FUserOnlineAccountAccelByte::SetUniqueDisplayName

(

const FString &

InUniqueDisplayName

)

Set user's unique display name on AccelByte services.

Parameters

InUniqueDisplayName

The user's display name

SetUserCountry()

void FUserOnlineAccountAccelByte::SetUserCountry

(

const FString &

InUserCountry

)

Set user's country on AccelByte services.

Parameters

InUserCountry

The user's country