social-common / pragma.presence / PresencePlugin / updateRichPresenceFromPlayer /

updateRichPresenceFromPlayer #

abstract suspend fun updateRichPresenceFromPlayer(socialId: <ERROR CLASS>, gameShardId: <ERROR CLASS>, currentPresence: Presence.Presence?, requestExt: ExtRichPresencePlayerRequest): ExtRichPresence

Called when a player attempts to update their presence. Use to validate their request and determine how their presence should be updated. The player’s current presence will be null if this action is creating their presence.

Used by:

  • FriendService.setPresenceV1

Parameters #

socialId

The social identifier for the player.

gameShardId

The game shard identifier the presence is associated with.

currentPresence

The current presence value for this player and game shard id.

requestExt

The custom-defined ext sent by the player.