Functions
static bool	PresenceClear (UObject *WorldContextObject, FOnlineManagerPresenceClearDelegate InPresenceClearDelegate)
	Clears a user's presence data in the current app. More...

static void	ReadInvitableUser (UObject *WorldContextObject, TArray< FString > SuggestedUserList, FOnlineManagerPresenceReadInvitableUserDelegate InReadInvitableUserDelegate)
	Reads a list of invitable users for a user. More...

static bool	GetInvitableFriendList (UObject *WorldContextObject, TArray< FPicoUserInfo > &OutFriendsList)
	Gets a list of invitable friends for a user. These friends are previously retrieved from the online service when `PresenceGetDestinations` is complete. More...

static bool	PresenceSet (UObject *WorldContextObject, const FString &ApiName, const FString &LobbySessionId, const FString &MatchSessionId, bool bIsJoinable, const FString &Extra, FOnlineManagerPresenceSetDelegate InPresenceSetDelegate)
	Sets presence data for a user in the current app. More...

static bool	PresenceSetDestination (UObject *WorldContextObject, const FString &ApiName, FOnlineManagerPresenceSetDestinationDelegate InPresenceSetDestinationDelegate)
	Replaces a user's current destination with the provided one. More...

static bool	PresenceSetIsJoinable (UObject *WorldContextObject, bool bIsJoinable, FOnlineManagerPresenceSetIsJoinableDelegate InPresenceSetIsJoinableDelegate)
	Sets whether a user is joinable. More...

static bool	PresenceSetLobbySession (UObject *WorldContextObject, const FString &LobbySession, FOnlineManagerPresenceSetLobbySessionDelegate InPresenceSetLobbySessionDelegate)
	Replaces a user's current lobby session ID with the provided one. More...

static bool	PresenceSetMatchSession (UObject *WorldContextObject, const FString &MatchSession, FOnlineManagerPresenceSetMatchSessionDelegate InPresenceSetMatchSessionDelegate)
	Replaces a user's current match session ID with the provided one. More...

static bool	PresenceSetExtra (UObject *WorldContextObject, const FString &Extra, FOnlineManagerPresenceSetExtraDelegate InPresenceSetExtraDelegate)
	Sets extra presence data for a user. More...

static bool	PresenceReadSendInvites (UObject *WorldContextObject, FOnlineManagerPresenceReadSentInvitesDelegate InPresenceReadSendInvitesDelegate)
	Reads a list of sent invitations. More...

static bool	PresenceSendInvites (UObject *WorldContextObject, TArray< FString > UserIdArray, FOnlineManagerPresenceSentInvitesDelegate InPresenceSentInvitesDelegate)
	Sends invitations to users. More...

static bool	GetSendInvitesList (UObject *WorldContextObject, TArray< FPicoApplicationInvite > &OutList)
	Gets a list of sent invitations when `PresenceSendInvites` or `PresenceReadSendInvites` is complete. More...

static bool	PresenceGetDestinations (UObject *WorldContextObject, FOnlineManagerPresenceGetDestinationsDelegate InPresenceGetDestinationsDelegate)
	Gets all the destinations that can be set for a user. More...

static bool	PresenceGetDestinationsList (UObject *WorldContextObject, TArray< FPicoDestination > &OutList)
	Gets a list of destinations when `PresenceGetDestinations` is complete. More...

static bool	LaunchInvitePanel (UObject *WorldContextObject, FOnlineManagerLaunchInvitePanelDelegate InLaunchInvitePanelDelegate)
	Call up the system panel to invite friends. More...

static bool	ShareMedia (UObject *WorldContextObject, EShareMediaType InMediaType, const FString &InVideoPath, const FString &InVideoThumbPath, TArray< FString > InImagePaths, EShareAppTyp InShareType, FOnlineManagerShareMediaDelegate InShareMediaDelegate)
	Share videos or pictures to different platforms, currently only support sharing to Douyin apps. More...

Detailed Description

This is the BP_Presence group

Function Documentation

◆ GetInvitableFriendList()

static bool GetInvitableFriendList	(	UObject *	WorldContextObject,
		TArray< FPicoUserInfo > &	OutFriendsList
	)

static

Gets a list of invitable friends for a user. These friends are previously retrieved from the online service when PresenceGetDestinations is complete.

Parameters

WorldContextObject Used to get the information about the current world.

Parameters

OutFriendsList The [out] array that receives the copied data.

Returns

Bool:

true: the friend list has been found.
false: otherwise

◆ GetSendInvitesList()

static bool GetSendInvitesList	(	UObject *	WorldContextObject,
		TArray< FPicoApplicationInvite > &	OutList
	)

static

Gets a list of sent invitations when PresenceSendInvites or PresenceReadSendInvites is complete.

Parameters

WorldContextObject	Used to get the information about the current world.
OutList	The [out] array that receives the copied data.

Returns

Bool:

true: the invitation list has been found.
false: otherwise

◆ LaunchInvitePanel()

static bool LaunchInvitePanel	(	UObject *	WorldContextObject,
		FOnlineManagerLaunchInvitePanelDelegate	InLaunchInvitePanelDelegate
	)

static

Call up the system panel to invite friends.

Parameters

WorldContextObject	Used to get the information about the current world.
InLaunchInvitePanelDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceClear()

static bool PresenceClear	(	UObject *	WorldContextObject,
		FOnlineManagerPresenceClearDelegate	InPresenceClearDelegate
	)

static

Clears a user's presence data in the current app.

Parameters

WorldContextObject	Used to get the information about the current world.
InPresenceClearDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceGetDestinations()

static bool PresenceGetDestinations	(	UObject *	WorldContextObject,
		FOnlineManagerPresenceGetDestinationsDelegate	InPresenceGetDestinationsDelegate
	)

static

Gets all the destinations that can be set for a user.

Note: Call PresenceGetDescriptionList after the Delegate has been executed.

Parameters

WorldContextObject	Used to get the information about the current world.
InPresenceGetDestinationsDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceGetDestinationsList()

static bool PresenceGetDestinationsList	(	UObject *	WorldContextObject,
		TArray< FPicoDestination > &	OutList
	)

static

Gets a list of destinations when PresenceGetDestinations is complete.

Parameters

WorldContextObject	Used to get the information about the current world.
OutList	The [out] array that receives the copied data.

Returns

Bool:

true: success
false: failure

◆ PresenceReadSendInvites()

static bool PresenceReadSendInvites	(	UObject *	WorldContextObject,
		FOnlineManagerPresenceReadSentInvitesDelegate	InPresenceReadSendInvitesDelegate
	)

static

Reads a list of sent invitations.

Note: Call GetSendInvitesList after the Delegate has been executed.

Parameters

WorldContextObject	Used to get the information about the current world.
InPresenceReadSendInvitesDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure
Returns

◆ PresenceSendInvites()

static bool PresenceSendInvites	(	UObject *	WorldContextObject,
		TArray< FString >	UserIdArray,
		FOnlineManagerPresenceSentInvitesDelegate	InPresenceSentInvitesDelegate
	)

static

Sends invitations to users.

Note: Call GetSendInvitesList after the Delegate has been executed.

Parameters

WorldContextObject	Used to get the information about the current world.
UserIdArray	The ID array of the users to invite.
InPresenceSentInvitesDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSet()

static bool PresenceSet	(	UObject *	WorldContextObject,
		const FString &	ApiName,
		const FString &	LobbySessionId,
		const FString &	MatchSessionId,
		bool	bIsJoinable,
		const FString &	Extra,
		FOnlineManagerPresenceSetDelegate	InPresenceSetDelegate
	)

static

Sets presence data for a user in the current app.

Parameters

WorldContextObject Used to get the information about the current world.

Parameters

ApiName	The API name of the destination.
LobbySessionId	Lobby session ID is used to identify a user group or team. Users with the same lobby session ID can play together or form a team in a game.
MatchSessionId	Match session ID is used to identify all users within a same destination, such as maps and levels. Users with different lobby session IDs will have the same match session ID when playing the same match.
bIsJoinable	Defines whether the user is joinable: `true`: joinable `false`: not joinable
Extra	Extra presence data defined by the developer.
InPresenceSetDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSetDestination()

static bool PresenceSetDestination	(	UObject *	WorldContextObject,
		const FString &	ApiName,
		FOnlineManagerPresenceSetDestinationDelegate	InPresenceSetDestinationDelegate
	)

static

Replaces a user's current destination with the provided one.

Note: Other presence parameter settings will remain the same.

Parameters

WorldContextObject Used to get the information about the current world.

Parameters

ApiName	The API name of the new destination.
InPresenceSetDestinationDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSetExtra()

static bool PresenceSetExtra	(	UObject *	WorldContextObject,
		const FString &	Extra,
		FOnlineManagerPresenceSetExtraDelegate	InPresenceSetExtraDelegate
	)

static

Sets extra presence data for a user.

Parameters

WorldContextObject	Used to get the information about the current world.
Extra	The extra presence data defined by the developer.
InPresenceSetExtraDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSetIsJoinable()

static bool PresenceSetIsJoinable	(	UObject *	WorldContextObject,
		bool	bIsJoinable,
		FOnlineManagerPresenceSetIsJoinableDelegate	InPresenceSetIsJoinableDelegate
	)

static

Sets whether a user is joinable.

Note: Other presence parameter settings will remain the same. If the destination or session ID has not been set up for the user, the user cannot be set to "joinable".

Parameters

WorldContextObject Used to get the information about the current world.

Parameters

bIsJoinable	Defines whether the user is joinable: `true`: joinable `false`: not joinable
InPresenceSetIsJoinableDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSetLobbySession()

static bool PresenceSetLobbySession	(	UObject *	WorldContextObject,
		const FString &	LobbySession,
		FOnlineManagerPresenceSetLobbySessionDelegate	InPresenceSetLobbySessionDelegate
	)

static

Replaces a user's current lobby session ID with the provided one.

Note: Other presence parameter settings will remain the same.

Parameters

WorldContextObject Used to get the information about the current world.

Parameters

LobbySession	The new lobby session ID.
InPresenceSetLobbySessionDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ PresenceSetMatchSession()

static bool PresenceSetMatchSession	(	UObject *	WorldContextObject,
		const FString &	MatchSession,
		FOnlineManagerPresenceSetMatchSessionDelegate	InPresenceSetMatchSessionDelegate
	)

static

Replaces a user's current match session ID with the provided one.

Note: Other presence-realated parameters will remain the same.

Parameters

WorldContextObject	Used to get the information about the current world.
MatchSession	The new match session ID.
InPresenceSetMatchSessionDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ ReadInvitableUser()

static void ReadInvitableUser	(	UObject *	WorldContextObject,
		TArray< FString >	SuggestedUserList,
		FOnlineManagerPresenceReadInvitableUserDelegate	InReadInvitableUserDelegate
	)

static

Reads a list of invitable users for a user.

Note: Call GetInvitableFriendList after the Delegate has been executed.

Parameters

WorldContextObject	Used to get the information about the current world.
SuggestedUserList	The ID list of the users suggested being invited.
InReadInvitableUserDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

◆ ShareMedia()

static bool ShareMedia	(	UObject *	WorldContextObject,
		EShareMediaType	InMediaType,
		const FString &	InVideoPath,
		const FString &	InVideoThumbPath,
		TArray< FString >	InImagePaths,
		EShareAppTyp	InShareType,
		FOnlineManagerShareMediaDelegate	InShareMediaDelegate
	)

static

Share videos or pictures to different platforms, currently only support sharing to Douyin apps.

Note: Video file requirements: For a better viewing experience, it is recommended to upload a 16:9 vertical video with a resolution of 720p(1280x720) and above Support common video formats, mp4 and webm are recommended The video file size should not exceed 128M and the duration should be within 15 minutes Videos over 50m are recommended to be uploaded in multiple segments, and the total video size should be within 4GB.A single shard is recommended to be 20MB, with a minimum of 5MB Image file requirements : The total size of the picture does not exceed 100M Up to 35 sheets at a time

Parameters

WorldContextObject	Used to get the information about the current world.
InMediaType	The media type: `0`: Video `1`: Image `2`: None
InVideoPath	The video file path.
InVideoThumbPath	The path of the video cover or the first few frames of the video as the video thumb.
InImagePaths	The array of image paths.
InShareType	The share type: `0`: Douyin `1`: None
InShareMediaDelegate	Will be executed when the request has been completed(bool, IsSuccessed, FString, ErrorMessage).

Returns

Bool:

true: success
false: failure

Functions

Detailed Description

Function Documentation

◆ GetInvitableFriendList()

◆ GetSendInvitesList()

◆ LaunchInvitePanel()

◆ PresenceClear()

◆ PresenceGetDestinations()

◆ PresenceGetDestinationsList()

◆ PresenceReadSendInvites()

◆ PresenceSendInvites()

◆ PresenceSet()

◆ PresenceSetDestination()

◆ PresenceSetExtra()

◆ PresenceSetIsJoinable()

◆ PresenceSetLobbySession()

◆ PresenceSetMatchSession()

◆ ReadInvitableUser()

◆ ShareMedia()