 | BrainCloudServiceClientPlayerState_UpdateSummaryFriendDataAsync Method |
[This is preliminary documentation and is subject to change.]
Updates the "friend summary data" associated with the logged in user.
Some operations will return this summary data. For instance the social
leaderboards will return the player's score in the leaderboard along
with the friend summary data. Generally this data is used to provide
a quick overview of the player without requiring a separate API call
to read their public stats or entity data.
Namespace: Ruyi.SDK.BrainCloudApi
Assembly: SDK.Gen.ServiceAsync (in SDK.Gen.ServiceAsync.dll) Version: 0.9.3.3995
SyntaxC#
public Task<string> PlayerState_UpdateSummaryFriendDataAsync( string jsonSummaryData, int clientIndex, CancellationToken cancellationToken )
Parameters
- jsonSummaryData
- Type: SystemString
A JSON string defining the summary data. For example: { "xp":123, "level":12, "highScore":45123 } - clientIndex
- Type: SystemInt32
@BrainCloud_clientIndex_desc - cancellationToken
- Type: System.ThreadingCancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.PlayerState_UpdateSummaryFriendDataAsync(System.String,System.Int32,System.Threading.CancellationToken)"]
Return Value
Type: TaskString[Missing <returns> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.PlayerState_UpdateSummaryFriendDataAsync(System.String,System.Int32,System.Threading.CancellationToken)"]
See Also