Ruyi.SDK.BrainCloudApi

BrainCloudService.Client Class

AsyncMatch_AbandonMatchAsync Method

AsyncMatch_CompleteMatchAsync Method

AsyncMatch_CreateMatchAsync Method

AsyncMatch_CreateMatchWithInitialTurnAsync Method

AsyncMatch_DeleteMatchAsync Method

AsyncMatch_FindCompleteMatchesAsync Method

AsyncMatch_FindMatchesAsync Method

AsyncMatch_ReadMatchAsync Method

AsyncMatch_ReadMatchHistoryAsync Method

AsyncMatch_SubmitTurnAsync Method

AsyncMatch_UpdateMatchSummaryDataAsync Method

Authentication_AuthenticateAnonymousAsync Method

Authentication_AuthenticateEmailPasswordAsync Method

Authentication_AuthenticateExternalAsync Method

Authentication_AuthenticatePhoneAsync Method

Authentication_AuthenticateUniversalAsync Method

Authentication_AuthenticateWechatAsync Method

Authentication_CheckUsernameExistsAsync Method

Authentication_ClearSavedProfileIDAsync Method

Authentication_GenerateAnonymousIdAsync Method

Authentication_GetWeChatQRPageURLAsync Method

Authentication_InitializeAsync Method

Authentication_RequestSmsCodeAsync Method

Authentication_ResetEmailPasswordAsync Method

Client_EnableLoggingAsync Method

Client_EnableNetworkErrorMessageCachingAsync Method

Client_FlushCachedMessagesAsync Method

Client_GetAuthenticationPacketTimeoutAsync Method

Client_GetPacketTimeoutsAsync Method

Client_GetSessionIdAsync Method

Client_GetUploadLowTransferRateThresholdAsync Method

Client_GetUploadLowTransferRateTimeoutAsync Method

Client_Initialize_SSSAsync Method

Client_Initialize_SSSSAsync Method

Client_InitializeIdentityAsync Method

Client_InsertEndOfMessageBundleMarkerAsync Method

Client_IsAuthenticatedAsync Method

Client_IsInitializedAsync Method

Client_OverrideCountryCodeAsync Method

Client_OverrideLanguageCodeAsync Method

Client_ResetCommunicationAsync Method

Client_RetryCachedMessagesAsync Method

Client_SetAuthenticationPacketTimeoutAsync Method

Client_SetPacketTimeoutsAsync Method

Client_SetPacketTimeoutsToDefaultAsync Method

Client_SetUploadLowTransferRateThresholdAsync Method

Client_SetUploadLowTransferRateTimeoutAsync Method

Client_UpdateAsync Method

DataStream_CustomPageEventAsync Method

DataStream_CustomScreenEventAsync Method

DataStream_CustomTrackEventAsync Method

Entity_CreateEntityAsync Method

Entity_DeleteEntityAsync Method

Entity_DeleteSingletonAsync Method

Entity_GetEntitiesByTypeAsync Method

Entity_GetEntityAsync Method

Entity_GetListAsync Method

Entity_GetListCountAsync Method

Entity_GetPageAsync Method

Entity_GetPageOffsetAsync Method

Entity_GetSharedEntitiesForProfileIdAsync Method

Entity_GetSharedEntitiesListForProfileIdAsync Method

Entity_GetSharedEntityForProfileIdAsync Method

Entity_GetSingletonAsync Method

Entity_IncrementSharedUserEntityDataAsync Method

Entity_IncrementUserEntityDataAsync Method

Entity_UpdateEntityAsync Method

Entity_UpdateSharedEntityAsync Method

Entity_UpdateSingletonAsync Method

Event_DeleteIncomingEventAsync Method

Event_GetEventsAsync Method

Event_SendEventAsync Method

Event_UpdateIncomingEventDataAsync Method

File_CancelDownloadAsync Method

File_CancelUploadAsync Method

File_DeleteUserFileAsync Method

File_DeleteUserFilesAsync Method

File_DownloadFileAsync Method

File_GetCDNUrlAsync Method

File_GetDownloadInfoAsync Method

File_GetUploadBytesTransferredAsync Method

File_GetUploadProgressAsync Method

File_GetUploadTotalBytesToTransferAsync Method

File_ListUserFiles_SFOAsync Method

File_ListUserFiles_SNSFOAsync Method

File_UploadFileAsync Method

Friend_AcceptFriendInvitationAsync Method

Friend_AddFriendsAsync Method

Friend_FindUserByUniversalIdAsync Method

Friend_FindUsersByExactNameAsync Method

Friend_FindUsersBySubstrNameAsync Method

Friend_GetSummaryDataForFriendsAsync Method

Friend_GetSummaryDataForProfileIdAsync Method

Friend_GetSummaryDataForProfileIdsAsync Method

Friend_GetSummaryDataForRecentlyMetPlayersAsync Method

Friend_GetUsersOnlineStatusAsync Method

Friend_ListFriendInvitationsReceivedAsync Method

Friend_ListFriendInvitationsSentAsync Method

Friend_ListFriendsAsync Method

Friend_ReadFriendEntityAsync Method

Friend_ReadFriendsEntitiesAsync Method

Friend_ReadFriendUserStateAsync Method

Friend_RejectFriendInvitationAsync Method

Friend_RemoveFriendAsync Method

Friend_RemoveFriendsAsync Method

Friend_SendFriendInvitationAsync Method

Gamification_AwardAchievementsAsync Method

Gamification_ReadAchievedAchievementsAsync Method

Gamification_ReadAchievementsAsync Method

Gamification_ReadAllGamificationAsync Method

Gamification_ReadCompletedMilestonesAsync Method

Gamification_ReadCompletedQuestsAsync Method

Gamification_ReadInProgressMilestonesAsync Method

Gamification_ReadInProgressQuestsAsync Method

Gamification_ReadMilestonesAsync Method

Gamification_ReadMilestonesByCategoryAsync Method

Gamification_ReadNotStartedQuestsAsync Method

Gamification_ReadQuestsAsync Method

Gamification_ReadQuestsByCategoryAsync Method

Gamification_ReadQuestsWithBasicPercentageAsync Method

Gamification_ReadQuestsWithComplexPercentageAsync Method

Gamification_ReadQuestsWithStatusAsync Method

Gamification_ReadXpLevelsMetaDataAsync Method

Gamification_ResetMilestonesAsync Method

GlobalApp_ReadPropertiesAsync Method

GlobalEntity_CreateEntityAsync Method

GlobalEntity_CreateEntityWithIndexedIdAsync Method

GlobalEntity_DeleteEntityAsync Method

GlobalEntity_GetListAsync Method

GlobalEntity_GetListByIndexedIdAsync Method

GlobalEntity_GetListCountAsync Method

GlobalEntity_GetPageAsync Method

GlobalEntity_GetPageOffsetAsync Method

GlobalEntity_GetRandomEntitiesMatchingAsync Method

GlobalEntity_IncrementGlobalEntityDataAsync Method

GlobalEntity_MakeSystemEntityAsync Method

GlobalEntity_ReadEntityAsync Method

GlobalEntity_UpdateEntityAclAsync Method

GlobalEntity_UpdateEntityAsync Method

GlobalEntity_UpdateEntityOwnerAndAclAsync Method

GlobalEntity_UpdateEntityTimeToLiveAsync Method

GlobalStatistics_IncrementGlobalStatsAsync Method

GlobalStatistics_ProcessStatisticsAsync Method

GlobalStatistics_ReadAllGlobalStatsAsync Method

GlobalStatistics_ReadGlobalStatsForCategoryAsync Method

GlobalStatistics_ReadGlobalStatsSubsetAsync Method

Group_AcceptGroupInvitationAsync Method

Group_AddGroupMemberAsync Method

Group_ApproveGroupJoinRequestAsync Method

Group_AutoJoinGroupAsync Method

Group_CancelGroupInvitationAsync Method

Group_CreateGroupAsync Method

Group_CreateGroupEntityAsync Method

Group_DeleteGroupAsync Method

Group_DeleteGroupEntityAsync Method

Group_GetMyGroupsAsync Method

Group_IncrementGroupDataAsync Method

Group_IncrementGroupEntityDataAsync Method

Group_InviteGroupMemberAsync Method

Group_JoinGroupAsync Method

Group_LeaveGroupAsync Method

Group_ListGroupsPageAsync Method

Group_ListGroupsPageByOffsetAsync Method

Group_ListGroupsWithMemberAsync Method

Group_ReadGroupAsync Method

Group_ReadGroupDataAsync Method

Group_ReadGroupEntitiesPageAsync Method

Group_ReadGroupEntitiesPageByOffsetAsync Method

Group_ReadGroupEntityAsync Method

Group_ReadGroupMembersAsync Method

Group_RejectGroupInvitationAsync Method

Group_RejectGroupJoinRequestAsync Method

Group_RemoveGroupMemberAsync Method

Group_UpdateGroupDataAsync Method

Group_UpdateGroupEntityDataAsync Method

Group_UpdateGroupMemberAsync Method

Group_UpdateGroupNameAsync Method

Identity_AttachEmailIdentityAsync Method

Identity_AttachParentWithIdentityAsync Method

Identity_AttachPeerProfileAsync Method

Identity_AttachUniversalIdentityAsync Method

Identity_ChangeEmailIdentityAsync Method

Identity_DetachEmailIdentityAsync Method

Identity_DetachParentAsync Method

Identity_DetachPeerAsync Method

Identity_DetachUniversalIdentityAsync Method

Identity_GetChildProfilesAsync Method

Identity_GetExpiredIdentitiesAsync Method

Identity_GetIdentitiesAsync Method

Identity_GetPeerProfilesAsync Method

Identity_MergeEmailIdentityAsync Method

Identity_MergeUniversalIdentityAsync Method

Identity_RefreshIdentityAsync Method

Identity_SwitchToChildProfileAsync Method

Identity_SwitchToParentProfileAsync Method

Identity_SwitchToSingletonChildProfileAsync Method

Lobby_CloseLobbyAsync Method

Lobby_CreateLobbyAsync Method

Lobby_DestroyLobbyAsync Method

Lobby_FindFriendsLobbiesAsync Method

Lobby_FindLobbiesAsync Method

Lobby_GetMyLobbiesAsync Method

Lobby_JoinLobbyAsync Method

Lobby_LeaveLobbyAsync Method

Lobby_OpenLobbyAsync Method

Lobby_StartGameAsync Method

Mail_SendAdvancedEmailAsync Method

Mail_SendAdvancedEmailByAddressAsync Method

Mail_SendBasicEmailAsync Method

MatchMaking_DecrementPlayerRatingAsync Method

MatchMaking_DisableMatchMakingAsync Method

MatchMaking_EnableMatchMakingAsync Method

MatchMaking_FindPlayersAsync Method

MatchMaking_FindPlayersUsingFilterAsync Method

MatchMaking_FindPlayersWithAttributesAsync Method

MatchMaking_FindPlayersWithAttributesUsingFilterAsync Method

MatchMaking_GetShieldExpiryAsync Method

MatchMaking_IncrementPlayerRatingAsync Method

MatchMaking_IncrementShieldOnForAsync Method

MatchMaking_ReadAsync Method

MatchMaking_ResetPlayerRatingAsync Method

MatchMaking_SetPlayerRatingAsync Method

MatchMaking_TurnShieldOffAsync Method

MatchMaking_TurnShieldOnAsync Method

MatchMaking_TurnShieldOnForAsync Method

OneWayMatch_CancelMatchAsync Method

OneWayMatch_CompleteMatchAsync Method

OneWayMatch_StartMatchAsync Method

Party_AcceptPartyInvitationAsync Method

Party_GetFriendsPartiesAsync Method

Party_GetMyPartyAsync Method

Party_GetPartyInfoAsync Method

Party_JoinPartyAsync Method

Party_LeavePartyAsync Method

Party_ListPartyInvitationsAsync Method

Party_RejectPartyInvitationAsync Method

Party_SendPartyInvitationAsync Method

Patch_GetGameManifestAsync Method

PlaybackStream_AddEventAsync Method

PlaybackStream_DeleteStreamAsync Method

PlaybackStream_EndStreamAsync Method

PlaybackStream_GetRecentStreamsForInitiatingPlayerAsync Method

PlaybackStream_GetRecentStreamsForTargetPlayerAsync Method

PlaybackStream_ReadStreamAsync Method

PlaybackStream_StartStreamAsync Method

PlayerState_DeleteUserAsync Method

PlayerState_GetAttributesAsync Method

PlayerState_LogoutAsync Method

PlayerState_ReadUserStateAsync Method

PlayerState_RemoveAttributesAsync Method

PlayerState_ResetUserAsync Method

PlayerState_UpdateAttributesAsync Method

PlayerState_UpdateContactEmailAsync Method

PlayerState_UpdateSummaryFriendDataAsync Method

PlayerState_UpdateUserNameAsync Method

PlayerState_UpdateUserPictureUrlAsync Method

PlayerStatistics_GetNextExperienceLevelAsync Method

PlayerStatistics_IncrementExperiencePointsAsync Method

PlayerStatistics_IncrementUserStats_DSFOAsync Method

PlayerStatistics_IncrementUserStats_SSFOAsync Method

PlayerStatistics_ProcessStatisticsAsync Method

PlayerStatistics_ReadAllUserStatsAsync Method

PlayerStatistics_ReadUserStatsForCategoryAsync Method

PlayerStatistics_ReadUserStatsSubsetAsync Method

PlayerStatistics_ResetAllUserStatsAsync Method

PlayerStatistics_SetExperiencePointsAsync Method

PlayerStatisticsEvent_TriggerStatsEventAsync Method

PlayerStatisticsEvent_TriggerStatsEventsAsync Method

Product_GetCurrencyAsync Method

Product_GetEligiblePromotionsAsync Method

Product_GetSalesInventoryAsync Method

Product_GetSalesInventoryByCategoryAsync Method

Product_VerifyItunesReceiptAsync Method

Product_VerifyMicrosoftReceiptAsync Method

Profanity_ProfanityCheckAsync Method

Profanity_ProfanityIdentifyBadWordsAsync Method

Profanity_ProfanityReplaceTextAsync Method

PushNotification_DeregisterAllPushNotificationDeviceTokensAsync Method

PushNotification_DeregisterPushNotificationDeviceTokenAsync Method

PushNotification_RegisterPushNotificationDeviceTokenAsync Method

PushNotification_ScheduleNormalizedPushNotificationMinutesAsync Method

PushNotification_ScheduleNormalizedPushNotificationUTCAsync Method

PushNotification_ScheduleRawPushNotificationMinutesAsync Method

PushNotification_ScheduleRawPushNotificationUTCAsync Method

PushNotification_ScheduleRichPushNotificationMinutesAsync Method

PushNotification_ScheduleRichPushNotificationUTCAsync Method

PushNotification_SendNormalizedPushNotificationAsync Method

PushNotification_SendNormalizedPushNotificationBatchAsync Method

PushNotification_SendNormalizedPushNotificationToGroupAsync Method

PushNotification_SendRawPushNotificationAsync Method

PushNotification_SendRawPushNotificationBatchAsync Method

PushNotification_SendRawPushNotificationToGroupAsync Method

PushNotification_SendRichPushNotificationAsync Method

PushNotification_SendRichPushNotificationWithParamsAsync Method

PushNotification_SendSimplePushNotificationAsync Method

PushNotification_SendTemplatedPushNotificationToGroupAsync Method

Script_CancelScheduledScriptAsync Method

Script_RunParentScriptAsync Method

Script_RunPeerScriptAsync Method

Script_RunPeerScriptAsynchAsync Method

Script_RunScriptAsync Method

Script_ScheduleRunScriptMinutesAsync Method

Script_ScheduleRunScriptUTCAsync Method

Shopping_AddToCart_ISFOAsync Method

Shopping_AddToCart_SISFOAsync Method

Shopping_AddToWishlistAsync Method

Shopping_EmptyCartAsync Method

Shopping_EmptyWishlistAsync Method

Shopping_FunnyUserReviewAsync Method

Shopping_GetCartAsync Method

Shopping_GetFeaturedProductsAsync Method

Shopping_GetMyLibraryAsync Method

Shopping_GetMyOrdersAsync Method

Shopping_GetMyUserTagsAsync Method

Shopping_GetMyWishlistAsync Method

Shopping_GetPopularProductsAsync Method

Shopping_GetPopularTagsAsync Method

Shopping_GetProductAsync Method

Shopping_GetProductsByTagAsync Method

Shopping_GetProductsByTagsAsync Method

Shopping_GetRecentlyCreatedProductsAsync Method

Shopping_GetRecentlyUpdatedProductsAsync Method

Shopping_GetRecommendedProductsAsync Method

Shopping_GetSpecialOffersAsync Method

Shopping_GetUserReviewsAsync Method

Shopping_GetUserTagsAsync Method

Shopping_GetWishlistAsync Method

Shopping_LikeUserReviewAsync Method

Shopping_RemoveFromCartAsync Method

Shopping_RemoveFromWishlist_ISFOAsync Method

Shopping_RemoveFromWishlist_SSFOAsync Method

Shopping_RemoveUserTagAsync Method

Shopping_SubmitUserReviewAsync Method

Shopping_SubmitUserTagAsync Method

Shopping_SubmitUserTagsAsync Method

Shopping_UnfunnyUserReviewAsync Method

Shopping_UnlikeUserReviewAsync Method

SocialFeed_BlockPlayerAsync Method

SocialFeed_GetActivityAsync Method

SocialFeed_GetCommentAsync Method

SocialFeed_HidePlayerAsync Method

SocialFeed_LikeActivityAsync Method

SocialFeed_LikeCommentAsync Method

SocialFeed_PostCommentAsync Method

SocialFeed_PostCommentReplyAsync Method

SocialFeed_ReadCommentRepliesAsync Method

SocialFeed_ReadCommentsAsync Method

SocialFeed_ReadFilteredSocialFeedAsync Method

SocialFeed_ReadFriendsSocialFeedAsync Method

SocialFeed_ReadSocialFeedAsync Method

SocialFeed_SetFeedVisibilityAsync Method

SocialFeed_ShareAchievementAsync Method

SocialFeed_ShareAppAsync Method

SocialFeed_ShareChannelAsync Method

SocialFeed_ShareGameGuideAsync Method

SocialFeed_ShareLinkAsync Method

SocialFeed_ShareScreenshotAsync Method

SocialFeed_ShareVideoAsync Method

SocialFeed_UnblockPlayerAsync Method

SocialFeed_UnhidePlayerAsync Method

SocialFeed_UnlikeActivityAsync Method

SocialFeed_UnlikeCommentAsync Method

SocialLeaderboard_GetGlobalLeaderboardEntryCountAsync Method

SocialLeaderboard_GetGlobalLeaderboardEntryCountByVersionAsync Method

SocialLeaderboard_GetGlobalLeaderboardPageAsync Method

SocialLeaderboard_GetGlobalLeaderboardPageByVersionAsync Method

SocialLeaderboard_GetGlobalLeaderboardVersionsAsync Method

SocialLeaderboard_GetGlobalLeaderboardViewAsync Method

SocialLeaderboard_GetGlobalLeaderboardViewByVersionAsync Method

SocialLeaderboard_GetGroupSocialLeaderboardAsync Method

SocialLeaderboard_GetMultiSocialLeaderboardAsync Method

SocialLeaderboard_GetPlayerScoreAsync Method

SocialLeaderboard_GetPlayerScoresFromLeaderboardsAsync Method

SocialLeaderboard_GetPlayersSocialLeaderboardAsync Method

SocialLeaderboard_GetSocialLeaderboardAsync Method

SocialLeaderboard_ListLeaderboardsAsync Method

SocialLeaderboard_PostScoreToDynamicLeaderboardAsync Method

SocialLeaderboard_PostScoreToDynamicLeaderboardDaysAsync Method

SocialLeaderboard_PostScoreToLeaderboardAsync Method

SocialLeaderboard_RemovePlayerScoreAsync Method

Telemetry_EndTelemetryEventAsync Method

Telemetry_EndTelemetrySessionAsync Method

Telemetry_LogTelemetryEventAsync Method

Telemetry_StartTelemetryEventAsync Method

Telemetry_StartTelemetrySessionAsync Method

Time_ReadServerTimeAsync Method

Tournament_ClaimTournamentRewardAsync Method

Tournament_GetTournamentStatusAsync Method

Tournament_JoinTournamentAsync Method

Tournament_LeaveTournamentAsync Method

Tournament_PostTournamentScoreAsync Method

Tournament_PostTournamentScoreWithResultsAsync Method

Tournament_ViewCurrentRewardAsync Method

Tournament_ViewRewardAsync Method

Click or drag to resize

BrainCloudServiceClientFriend_ListFriendsAsync Method

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]

Namespace: Ruyi.SDK.BrainCloudApi
Assembly: SDK.Gen.ServiceAsync (in SDK.Gen.ServiceAsync.dll) Version: 0.9.3.3995

Syntax

C#

public Task<string> Friend_ListFriendsAsync(
	FriendPlatform friendPlatform,
	bool includeSummaryData,
	int clientIndex,
	CancellationToken cancellationToken
)

Parameters

friendPlatform: Type: Ruyi.SDK.BrainCloudApiFriendPlatform
[Missing <param name="friendPlatform"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]
includeSummaryData: Type: SystemBoolean
[Missing <param name="includeSummaryData"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]
clientIndex: Type: SystemInt32
[Missing <param name="clientIndex"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]
cancellationToken: Type: System.ThreadingCancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]

Return Value

Type: TaskString

[Missing <returns> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.Friend_ListFriendsAsync(Ruyi.SDK.BrainCloudApi.FriendPlatform,System.Boolean,System.Int32,System.Threading.CancellationToken)"]

See Also

Reference

BrainCloudServiceClient Class

Ruyi.SDK.BrainCloudApi Namespace

Copyright ©Zhongshan Subor Advanced Technology Co., Ltd. 2017-2018, All right reserved

Send comments on this topic to dev-support@playruyi.com