 | Client Methods |
[This is preliminary documentation and is subject to change.]
The BrainCloudServiceClient type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AsyncMatch_AbandonMatchAsync | Marks the given match as abandoned. |
| AsyncMatch_CompleteMatchAsync | Marks the given match as complete. |
| AsyncMatch_CreateMatchAsync | Creates an instance of an asynchronous match. |
| AsyncMatch_CreateMatchWithInitialTurnAsync | Creates an instance of an asynchronous match with an initial turn. |
| AsyncMatch_DeleteMatchAsync | Removes the match and match history from the server. DEBUG ONLY, in production it is recommended
the user leave it as completed. |
| AsyncMatch_FindCompleteMatchesAsync | Returns all matches that are in a COMPLETE state for which the player is involved. |
| AsyncMatch_FindMatchesAsync | Returns all matches that are NOT in a COMPLETE state for which the player is involved. |
| AsyncMatch_ReadMatchAsync | Returns the current state of the given match. |
| AsyncMatch_ReadMatchHistoryAsync | Returns the match history of the given match. |
| AsyncMatch_SubmitTurnAsync | Submits a turn for the given match. |
| AsyncMatch_UpdateMatchSummaryDataAsync | Allows the current player (only) to update Summary data without having to submit a whole turn. |
| Authentication_AuthenticateAnonymousAsync | Authenticate a user anonymously with brainCloud - used for apps that don't want to bother
the user to login, or for users who are sensitive to their privacy |
| Authentication_AuthenticateEmailPasswordAsync | Authenticate the user with a custom Email and Password. Note that the client app
is responsible for collecting (and storing) the e-mail and potentially password
(for convenience) in the client data. For the greatest security,
force the user to re-enter their password at each login.
(Or at least give them that option). |
| Authentication_AuthenticateExternalAsync | Authenticate the user via cloud code (which in turn validates the supplied credentials against an external system).
This allows the developer to extend brainCloud authentication to support other backend authentication systems. |
| Authentication_AuthenticatePhoneAsync | Authenticate the user via wechat |
| Authentication_AuthenticateUniversalAsync | Authenticate the user using a userId and password (without any validation on the userId).
Similar to AuthenticateEmailPassword - except that that method has additional features to
allow for e-mail validation, password resets, etc. |
| Authentication_AuthenticateWechatAsync | Authenticate the user via wechat |
| Authentication_CheckUsernameExistsAsync | |
| Authentication_ClearSavedProfileIDAsync | Used to clear the saved profile id - to use in cases when the user is
attempting to switch to a different app profile. |
| Authentication_GenerateAnonymousIdAsync | Used to create the anonymous installation id for the brainCloud profile. |
| Authentication_GetWeChatQRPageURLAsync | @Authentication_GetWeChatQRPageURL_desc |
| Authentication_InitializeAsync | Initialize - initializes the identity service with a saved
anonymous installation id and most recently used profile id |
| Authentication_RequestSmsCodeAsync | Request an SMS code sent to a phone prior to authentication. |
| Authentication_ResetEmailPasswordAsync | Reset Email password - Sends a password reset email to the specified address |
| Client_EnableLoggingAsync | Enable logging of brainCloud transactions (comms etc) |
| Client_EnableNetworkErrorMessageCachingAsync | Enables the timeout message caching which is disabled by default.
Once enabled, if a client side timeout is encountered
(i.e. brainCloud server is unreachable presumably due to the client
network being down) the SDK will do the following:
1 - cache the currently queued messages to brainCloud
2 - call the network error callback
3 - then expect the app to call either:
a) RetryCachedMessages() to retry sending to brainCloud
b) FlushCachedMessages() to dump all messages in the queue.
Between steps 2 and 3, the app can prompt the user to retry connecting
to brainCloud to determine whether to follow path 3a or 3b.
Note that if path 3a is followed, and another timeout is encountered,
the process will begin all over again from step 1.
WARNING - the brainCloud SDK will cache *all* API calls sent
when a timeout is encountered if this mechanism is enabled.
This effectively freezes all communication with brainCloud.
Apps must call either RetryCachedMessages() or FlushCachedMessages()
for the brainCloud SDK to resume sending messages.
ResetCommunication() will also clear the message cache. |
| Client_FlushCachedMessagesAsync | Flushes the cached messages to resume API call processing. This will dump
all of the cached messages in the queue. |
| Client_GetAuthenticationPacketTimeoutAsync | Gets the authentication packet timeout which is tracked separately
from all other packets. Note that authentication packets are never
retried and so this value represents the total time a client would
wait to receive a reply to an authentication API call. By default
this timeout is set to 15 seconds. |
| Client_GetPacketTimeoutsAsync | Returns the list of packet timeouts. |
| Client_GetSessionIdAsync | Returns the sessionId or empty string if no session present. |
| Client_GetUploadLowTransferRateThresholdAsync | Returns the low transfer rate threshold in bytes/sec |
| Client_GetUploadLowTransferRateTimeoutAsync | Returns the low transfer rate timeout in secs |
| Client_Initialize_SSSAsync | Method initializes the BrainCloudClient. |
| Client_Initialize_SSSSAsync | Method initializes the BrainCloudClient. |
| Client_InitializeIdentityAsync | Initialize the identity aspects of brainCloud. |
| Client_InsertEndOfMessageBundleMarkerAsync | Inserts a marker which will tell the brainCloud comms layer
to close the message bundle off at this point. Any messages queued
before this method was called will likely be bundled together in
the next send to the server.
To ensure that only a single message is sent to the server you would
do something like this:
InsertEndOfMessageBundleMarker()
SomeApiCall()
InsertEndOfMessageBundleMarker() |
| Client_IsAuthenticatedAsync | Returns true if the user is currently authenticated.
If a session time out or session invalidation is returned from executing a
sever API call, this flag will reset back to false. |
| Client_IsInitializedAsync | Returns true if brainCloud has been initialized. |
| Client_OverrideCountryCodeAsync | Sets the country code sent to brainCloud when a user authenticates.
Will override any auto detected country. |
| Client_OverrideLanguageCodeAsync | Sets the language code sent to brainCloud when a user authenticates.
If the language is set to a non-ISO 639-1 standard value the game default will be used instead.
Will override any auto detected language. |
| Client_ResetCommunicationAsync | Resets all messages and calls to the server |
| Client_RetryCachedMessagesAsync | Attempts to resend any cached messages. If no messages are in the cache,
this method does nothing. |
| Client_SetAuthenticationPacketTimeoutAsync | Sets the authentication packet timeout which is tracked separately
from all other packets. Note that authentication packets are never
retried and so this value represents the total time a client would
wait to receive a reply to an authentication API call. By default
this timeout is set to 15 seconds. |
| Client_SetPacketTimeoutsAsync | |
| Client_SetPacketTimeoutsToDefaultAsync | Sets the packet timeouts back to default. |
| Client_SetUploadLowTransferRateThresholdAsync | Sets the low transfer rate threshold of an upload in bytes/sec.
If the transfer rate dips below the given threshold longer
than the specified timeout, the transfer will fail.
By default this is set to 50 bytes/sec. Note that this timeout method
does not work on Unity mobile platforms. |
| Client_SetUploadLowTransferRateTimeoutAsync | Sets the timeout in seconds of a low speed upload
(i.e. transfer rate which is underneath the low transfer rate threshold).
By default this is set to 120 secs.Setting this value to 0 will
turn off the timeout. Note that this timeout method
does not work on Unity mobile platforms. |
| Client_UpdateAsync | Update method needs to be called regularly in order
to process incoming and outgoing messages. |
| DataStream_CustomPageEventAsync | Creates custom data stream page event |
| DataStream_CustomScreenEventAsync | Creates custom data stream screen event |
| DataStream_CustomTrackEventAsync | Creates custom data stream track event |
| Entity_CreateEntityAsync | Method creates a new entity on the server. |
| Entity_DeleteEntityAsync | Method deletes the given entity on the server. |
| Entity_DeleteSingletonAsync | Method deletes the given singleton on the server. |
| Entity_GetEntitiesByTypeAsync | Method returns all user entities that match the given type. |
| Entity_GetEntityAsync | Method to get a specific entity. |
| Entity_GetListAsync | Method gets list of entities from the server base on type and/or where clause |
| Entity_GetListCountAsync | Method gets a count of entities based on the where clause |
| Entity_GetPageAsync | Method uses a paging system to iterate through user entities.
After retrieving a page of entities with this method,
use GetPageOffset() to retrieve previous or next pages. |
| Entity_GetPageOffsetAsync | Method to retrieve previous or next pages after having called
the GetPage method. |
| Entity_GetSharedEntitiesForProfileIdAsync | Method returns all shared entities for the given profile id.
An entity is shared if its ACL allows for the currently logged
in user to read the data. |
| Entity_GetSharedEntitiesListForProfileIdAsync | Method gets list of shared entities for the specified user based on type and/or where clause |
| Entity_GetSharedEntityForProfileIdAsync | Method returns a shared entity for the given profile and entity ID.
An entity is shared if its ACL allows for the currently logged
in user to read the data. |
| Entity_GetSingletonAsync | Method retrieves a singleton entity on the server. If the entity doesn't exist, null is returned. |
| Entity_IncrementSharedUserEntityDataAsync | Partial increment of shared entity data field items. Partial set of items incremented as specified. |
| Entity_IncrementUserEntityDataAsync | Partial increment of entity data field items. Partial set of items incremented as specified. |
| Entity_UpdateEntityAsync | Method updates a new entity on the server. This operation results in the entity
data being completely replaced by the passed in JSON string. |
| Entity_UpdateSharedEntityAsync | Method updates a shared entity owned by another user. This operation results in the entity
data being completely replaced by the passed in JSON string. |
| Entity_UpdateSingletonAsync | Method updates a singleton entity on the server. This operation results in the entity
data being completely replaced by the passed in JSON string. If the entity doesn't exist it is created. |
| Event_DeleteIncomingEventAsync | Delete an event out of the user's incoming mailbox. |
| Event_GetEventsAsync | Get the events currently queued for the user. |
| Event_SendEventAsync | Sends an event to the designated profile id with the attached json data.
Any events that have been sent to a user will show up in their
incoming event mailbox. If the recordLocally flag is set to true,
a copy of this event (with the exact same event id) will be stored
in the sending user's "sent" event mailbox. |
| Event_UpdateIncomingEventDataAsync | Updates an event in the user's incoming event mailbox. |
| File_CancelDownloadAsync | @BrainCloud_CancelDownload_desc |
| File_CancelUploadAsync | Method cancels an upload. If an IFileUploadCallback has been registered with the BrainCloudClient class,
the fileUploadFailed callback method will be called once the upload has been canceled.
NOTE: The upload will still continue in the background on versions of Unity before 5.3
and on Unity mobile platforms. |
| File_DeleteUserFileAsync | Deletes a single user file. |
| File_DeleteUserFilesAsync | Delete multiple user files |
| File_DownloadFileAsync | @BrainCloud_DownloadFile_desc |
| File_GetCDNUrlAsync | Returns the CDN URL for a file object. |
| File_GetDownloadInfoAsync | @BrainCloud_GetDownloadInfo_desc |
| File_GetUploadBytesTransferredAsync | Returns the number of bytes uploaded or -1 if upload not found.
NOTE: This will always return the total bytes to transfer on Unity mobile platforms. |
| File_GetUploadProgressAsync | Returns the progress of the given upload from 0.0 to 1.0 or -1 if upload not found.
NOTE: This will always return 1 on Unity mobile platforms. |
| File_GetUploadTotalBytesToTransferAsync | Returns the total number of bytes that will be uploaded or -1 if upload not found. |
| File_ListUserFiles_SFOAsync | List all user files |
| File_ListUserFiles_SNSFOAsync | List user files from the given cloud path |
| File_UploadFileAsync | Prepares a user file upload. On success the file will begin uploading
to the brainCloud server.To be informed of success/failure of the upload
register an IFileUploadCallback with the BrainCloudClient class. |
| Friend_AcceptFriendInvitationAsync | |
| Friend_AddFriendsAsync | |
| Friend_FindUserByUniversalIdAsync | |
| Friend_FindUsersByExactNameAsync | Finds a list of users matching the search text by performing an exact
search of all user names. |
| Friend_FindUsersBySubstrNameAsync | Finds a list of users matching the search text by performing a substring
search of all user names. |
| Friend_GetSummaryDataForFriendsAsync | Returns user state of the player's friends. |
| Friend_GetSummaryDataForProfileIdAsync | Returns user state of a particular user. |
| Friend_GetSummaryDataForProfileIdsAsync | |
| Friend_GetSummaryDataForRecentlyMetPlayersAsync | Returns user state of player's recently met. |
| Friend_GetUsersOnlineStatusAsync | |
| Friend_ListFriendInvitationsReceivedAsync | |
| Friend_ListFriendInvitationsSentAsync | |
| Friend_ListFriendsAsync | |
| Friend_ReadFriendEntityAsync | Returns a particular entity of a particular friend. |
| Friend_ReadFriendsEntitiesAsync | Returns entities of all friends based on type and/or subtype. |
| Friend_ReadFriendUserStateAsync | Returns user state of a particular friend. |
| Friend_RejectFriendInvitationAsync | |
| Friend_RemoveFriendAsync | |
| Friend_RemoveFriendsAsync | |
| Friend_SendFriendInvitationAsync | |
| Gamification_AwardAchievementsAsync | |
| Gamification_ReadAchievedAchievementsAsync | Method retrives the list of achieved achievements. |
| Gamification_ReadAchievementsAsync | Read all of the achievements defined for the game. |
| Gamification_ReadAllGamificationAsync | Method retrieves all gamification data for the player. |
| Gamification_ReadCompletedMilestonesAsync | Method retrieves the list of completed milestones. |
| Gamification_ReadCompletedQuestsAsync | Method returns all completed quests. |
| Gamification_ReadInProgressMilestonesAsync | Method retrieves the list of in progress milestones |
| Gamification_ReadInProgressQuestsAsync | Method returns all in progress quests. |
| Gamification_ReadMilestonesAsync | Method retrieves all milestones defined for the game. |
| Gamification_ReadMilestonesByCategoryAsync | Method retrieves milestones of the given category. |
| Gamification_ReadNotStartedQuestsAsync | Method returns all quests that haven't been started. |
| Gamification_ReadQuestsAsync | Method retrieves all of the quests defined for the game. |
| Gamification_ReadQuestsByCategoryAsync | Method returns all quests for the given category. |
| Gamification_ReadQuestsWithBasicPercentageAsync | Method returns all quests with a basic percentage. |
| Gamification_ReadQuestsWithComplexPercentageAsync | Method returns all quests with a complex percentage. |
| Gamification_ReadQuestsWithStatusAsync | Method returns all quests with status. |
| Gamification_ReadXpLevelsMetaDataAsync | Method returns all defined xp levels and any rewards associated
with those xp levels. |
| Gamification_ResetMilestonesAsync | |
| GlobalApp_ReadPropertiesAsync | Method reads all the global properties of the game |
| GlobalEntity_CreateEntityAsync | Method creates a new entity on the server. |
| GlobalEntity_CreateEntityWithIndexedIdAsync | Method creates a new entity on the server with an indexed id. |
| GlobalEntity_DeleteEntityAsync | Method deletes an existing entity on the server. |
| GlobalEntity_GetListAsync | Method gets list of entities from the server base on type and/or where clause |
| GlobalEntity_GetListByIndexedIdAsync | Method gets list of entities from the server base on indexed id |
| GlobalEntity_GetListCountAsync | Method gets a count of entities based on the where clause |
| GlobalEntity_GetPageAsync | Method uses a paging system to iterate through Global Entities.
After retrieving a page of Global Entities with this method,
use GetPageOffset() to retrieve previous or next pages. |
| GlobalEntity_GetPageOffsetAsync | Method to retrieve previous or next pages after having called
the GetPage method. |
| GlobalEntity_GetRandomEntitiesMatchingAsync | Gets a list of up to randomCount randomly selected entities from the server based on the where condition and specified maximum return count. |
| GlobalEntity_IncrementGlobalEntityDataAsync | Partial increment of global entity data field items. Partial set of items incremented as specified. |
| GlobalEntity_MakeSystemEntityAsync | |
| GlobalEntity_ReadEntityAsync | Method reads an existing entity from the server. |
| GlobalEntity_UpdateEntityAclAsync | Method updates an existing entity's Acl on the server. |
| GlobalEntity_UpdateEntityAsync | Method updates an existing entity on the server. |
| GlobalEntity_UpdateEntityOwnerAndAclAsync | |
| GlobalEntity_UpdateEntityTimeToLiveAsync | Method updates an existing entity's time to live on the server. |
| GlobalStatistics_IncrementGlobalStatsAsync | Atomically increment (or decrement) global statistics.
Global statistics are defined through the brainCloud portal. |
| GlobalStatistics_ProcessStatisticsAsync | |
| GlobalStatistics_ReadAllGlobalStatsAsync | Method returns all of the global statistics. |
| GlobalStatistics_ReadGlobalStatsForCategoryAsync | Method retrieves the global statistics for the given category. |
| GlobalStatistics_ReadGlobalStatsSubsetAsync | |
| Group_AcceptGroupInvitationAsync | Accept an outstanding invitation to join the group. |
| Group_AddGroupMemberAsync | |
| Group_ApproveGroupJoinRequestAsync | |
| Group_AutoJoinGroupAsync | |
| Group_CancelGroupInvitationAsync | Cancel an outstanding invitation to the group. |
| Group_CreateGroupAsync | |
| Group_CreateGroupEntityAsync | |
| Group_DeleteGroupAsync | Delete a group. |
| Group_DeleteGroupEntityAsync | Delete a group entity. |
| Group_GetMyGroupsAsync | Read information on groups to which the current user belongs. |
| Group_IncrementGroupDataAsync | Increment elements for the group's data field. |
| Group_IncrementGroupEntityDataAsync | Increment elements for the group entity's data field. |
| Group_InviteGroupMemberAsync | |
| Group_JoinGroupAsync | Join an open group or request to join a closed group. |
| Group_LeaveGroupAsync | Leave a group in which the user is a member. |
| Group_ListGroupsPageAsync | Retrieve a page of group summary information based on the specified context. |
| Group_ListGroupsPageByOffsetAsync | Retrieve a page of group summary information based on the encoded context
and specified page offset. |
| Group_ListGroupsWithMemberAsync | Read information on groups to which the specified user belongs. Access is subject to restrictions. |
| Group_ReadGroupAsync | Read the specified group. |
| Group_ReadGroupDataAsync | Read the data of the specified group. |
| Group_ReadGroupEntitiesPageAsync | Read a page of group entity information. |
| Group_ReadGroupEntitiesPageByOffsetAsync | Read a page of group entity information. |
| Group_ReadGroupEntityAsync | Read the specified group entity. |
| Group_ReadGroupMembersAsync | Read the members of the group. |
| Group_RejectGroupInvitationAsync | Reject an outstanding invitation to join the group. |
| Group_RejectGroupJoinRequestAsync | Reject an outstanding request to join the group. |
| Group_RemoveGroupMemberAsync | Remove a member from the group. |
| Group_UpdateGroupDataAsync | Updates a group's data. |
| Group_UpdateGroupEntityDataAsync | Update a group entity. |
| Group_UpdateGroupMemberAsync | |
| Group_UpdateGroupNameAsync | Updates a group's name. |
| Identity_AttachEmailIdentityAsync | Attach a Email and Password identity to the current profile. |
| Identity_AttachParentWithIdentityAsync | Attach a new identity to a parent app |
| Identity_AttachPeerProfileAsync | Attaches a peer identity to this user's profile |
| Identity_AttachUniversalIdentityAsync | Attach a Universal (userId + password) identity to the current profile. |
| Identity_ChangeEmailIdentityAsync | Allows email identity email address to be changed |
| Identity_DetachEmailIdentityAsync | Detach the e-mail identity from the current profile |
| Identity_DetachParentAsync | Detaches parent from this user's profile |
| Identity_DetachPeerAsync | Detaches a peer identity from this user's profile |
| Identity_DetachUniversalIdentityAsync | Detach the universal identity from the current profile |
| Identity_GetChildProfilesAsync | Returns a list of all child profiles in child Apps |
| Identity_GetExpiredIdentitiesAsync | Retrieve list of expired identities |
| Identity_GetIdentitiesAsync | Retrieve list of identities |
| Identity_GetPeerProfilesAsync | Retrieves a list of attached peer profiles |
| Identity_MergeEmailIdentityAsync | Merge the profile associated with the provided e=mail with the current profile. |
| Identity_MergeUniversalIdentityAsync | Merge the profile associated with the provided e=mail with the current profile. |
| Identity_RefreshIdentityAsync | Refreshes an identity for this user |
| Identity_SwitchToChildProfileAsync | Switch to a Child Profile |
| Identity_SwitchToParentProfileAsync | Switch to a Parent Profile |
| Identity_SwitchToSingletonChildProfileAsync | Switches to the child profile of an app when only one profile exists
If multiple profiles exist this returns an error |
| Lobby_CloseLobbyAsync | Close a lobby so players can't join. |
| Lobby_CreateLobbyAsync | |
| Lobby_DestroyLobbyAsync | Destroy a lobby. |
| Lobby_FindFriendsLobbiesAsync | Find lobbies with the player's friends in them. |
| Lobby_FindLobbiesAsync | Find lobbies the player can join. |
| Lobby_GetMyLobbiesAsync | Get a list of lobbies the player is a member of. |
| Lobby_JoinLobbyAsync | Join a lobby. |
| Lobby_LeaveLobbyAsync | Leave a lobby. |
| Lobby_OpenLobbyAsync | Open a lobby so players can join. |
| Lobby_StartGameAsync | Start a lobby game. |
| Mail_SendAdvancedEmailAsync | Sends an advanced email to the specified user |
| Mail_SendAdvancedEmailByAddressAsync | Sends an advanced email to the specified email address |
| Mail_SendBasicEmailAsync | Sends a simple text email to the specified user |
| MatchMaking_DecrementPlayerRatingAsync | Decrements player rating |
| MatchMaking_DisableMatchMakingAsync | Disables Match Making for the Player |
| MatchMaking_EnableMatchMakingAsync | Enables Match Making for the Player |
| MatchMaking_FindPlayersAsync | Finds matchmaking enabled players |
| MatchMaking_FindPlayersUsingFilterAsync | Finds matchmaking enabled players using a cloud code filter |
| MatchMaking_FindPlayersWithAttributesAsync | Finds matchmaking enabled players with additional attributes |
| MatchMaking_FindPlayersWithAttributesUsingFilterAsync | Finds matchmaking enabled players using a cloud code filter
and additional attributes |
| MatchMaking_GetShieldExpiryAsync | Gets the shield expiry for the given player id. Passing in a null player id
will return the shield expiry for the current player. The value returned is
the time in UTC millis when the shield will expire. |
| MatchMaking_IncrementPlayerRatingAsync | Increments player rating |
| MatchMaking_IncrementShieldOnForAsync | Increases the shield on time by specified number of minutes |
| MatchMaking_ReadAsync | Read match making record |
| MatchMaking_ResetPlayerRatingAsync | Resets player rating |
| MatchMaking_SetPlayerRatingAsync | Sets player rating |
| MatchMaking_TurnShieldOffAsync | Turns shield off |
| MatchMaking_TurnShieldOnAsync | Turns shield on |
| MatchMaking_TurnShieldOnForAsync | Turns shield on for the specified number of minutes |
| OneWayMatch_CancelMatchAsync | Cancels a match |
| OneWayMatch_CompleteMatchAsync | Completes a match |
| OneWayMatch_StartMatchAsync | Starts a match |
| Party_AcceptPartyInvitationAsync | |
| Party_GetFriendsPartiesAsync | |
| Party_GetMyPartyAsync | |
| Party_GetPartyInfoAsync | |
| Party_JoinPartyAsync | |
| Party_LeavePartyAsync | |
| Party_ListPartyInvitationsAsync | |
| Party_RejectPartyInvitationAsync | |
| Party_SendPartyInvitationAsync | |
| Patch_GetGameManifestAsync | |
| PlaybackStream_AddEventAsync | Adds a stream event |
| PlaybackStream_DeleteStreamAsync | Deletes a stream |
| PlaybackStream_EndStreamAsync | Ends a stream |
| PlaybackStream_GetRecentStreamsForInitiatingPlayerAsync | Gets recent streams for initiating player |
| PlaybackStream_GetRecentStreamsForTargetPlayerAsync | Gets recent streams for target player |
| PlaybackStream_ReadStreamAsync | Reads a stream |
| PlaybackStream_StartStreamAsync | Starts a stream |
| PlayerState_DeleteUserAsync | Completely deletes the user record and all data fully owned
by the user. After calling this method, the user will need
to re-authenticate and create a new profile.
This is mostly used for debugging/qa. |
| PlayerState_GetAttributesAsync | Retrieve the user's attributes. |
| PlayerState_LogoutAsync | Logs user out of server. |
| PlayerState_ReadUserStateAsync | Read the state of the currently logged in user.
This method returns a JSON object describing most of the
player's data: entities, statistics, level, currency.
Apps will typically call this method after authenticating to get an
up-to-date view of the user's data. |
| PlayerState_RemoveAttributesAsync | |
| PlayerState_ResetUserAsync | This method will delete *most* data for the currently logged in user.
Data which is not deleted includes: currency, credentials, and
purchase transactions. ResetUser is different from DeleteUser in that
the player record will continue to exist after the reset (so the user
does not need to re-authenticate). |
| PlayerState_UpdateAttributesAsync | Update user's attributes. |
| PlayerState_UpdateContactEmailAsync | Update the user's contact email.
Note this is unrelated to email authentication. |
| PlayerState_UpdateSummaryFriendDataAsync | 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. |
| PlayerState_UpdateUserNameAsync | Sets the user name. |
| PlayerState_UpdateUserPictureUrlAsync | Updates player's picture URL. |
| PlayerStatistics_GetNextExperienceLevelAsync | Returns JSON representing the next experience level for the user. |
| PlayerStatistics_IncrementExperiencePointsAsync | Increments the user's experience. If the user goes up a level,
the new level details will be returned along with a list of rewards. |
| PlayerStatistics_IncrementUserStats_DSFOAsync | |
| PlayerStatistics_IncrementUserStats_SSFOAsync | Atomically increment (or decrement) user statistics.
Any rewards that are triggered from user statistic increments
will be considered. User statistics are defined through the brainCloud portal.
Note also that the "xpCapped" property is returned (true/false depending on whether
the xp cap is turned on and whether the user has hit it). |
| PlayerStatistics_ProcessStatisticsAsync | |
| PlayerStatistics_ReadAllUserStatsAsync | Read all available user statistics. |
| PlayerStatistics_ReadUserStatsForCategoryAsync | Method retrieves the user statistics for the given category. |
| PlayerStatistics_ReadUserStatsSubsetAsync | |
| PlayerStatistics_ResetAllUserStatsAsync | Reset all of the statistics for this user back to their initial value. |
| PlayerStatistics_SetExperiencePointsAsync | Sets the user's experience to an absolute value. Note that this
is simply a set and will not reward the user if their level changes
as a result. |
| PlayerStatisticsEvent_TriggerStatsEventAsync | Trigger an event server side that will increase the user statistics.
This may cause one or more awards to be sent back to the user -
could be achievements, experience, etc. Achievements will be sent by this
client library to the appropriate awards service (Apple Game Center, etc).
This mechanism supercedes the PlayerStatisticsService API methods, since
PlayerStatisticsService API method only update the raw statistics without
triggering the rewards. |
| PlayerStatisticsEvent_TriggerStatsEventsAsync | See documentation for TriggerStatsEvent for more
documentation. |
| Product_GetCurrencyAsync | Gets the player's currency for the given currency type
or all currency types if null passed in. |
| Product_GetEligiblePromotionsAsync | Returns the eligible promotions for the player. |
| Product_GetSalesInventoryAsync | Method gets the active sales inventory for the passed-in
currency type. |
| Product_GetSalesInventoryByCategoryAsync | Method gets the active sales inventory for the passed-in
currency type and category. |
| Product_VerifyItunesReceiptAsync | Verify ITunes Receipt. On success, the player will be awarded the
associated currencies. |
| Product_VerifyMicrosoftReceiptAsync | Verify Microsoft Receipt. On success, the player will be awarded the
associated currencies. |
| Profanity_ProfanityCheckAsync | Checks supplied text for profanity. |
| Profanity_ProfanityIdentifyBadWordsAsync | Checks supplied text for profanity and returns a list of bad wors. |
| Profanity_ProfanityReplaceTextAsync | Replaces the characters of profanity text with a passed character(s). |
| PushNotification_DeregisterAllPushNotificationDeviceTokensAsync | Deregisters all device tokens currently registered to the user. |
| PushNotification_DeregisterPushNotificationDeviceTokenAsync | Deregisters the given device token from the server to disable this device
from receiving push notifications. |
| PushNotification_RegisterPushNotificationDeviceTokenAsync | Registers the given device token with the server to enable this device
to receive push notifications. |
| PushNotification_ScheduleNormalizedPushNotificationMinutesAsync | Schedules a normalized push notification to a user |
| PushNotification_ScheduleNormalizedPushNotificationUTCAsync | Schedules a normalized push notification to a user |
| PushNotification_ScheduleRawPushNotificationMinutesAsync | Schedules raw notifications based on user local time. |
| PushNotification_ScheduleRawPushNotificationUTCAsync | Schedules raw notifications based on user local time. |
| PushNotification_ScheduleRichPushNotificationMinutesAsync | Schedules a rich push notification to a user |
| PushNotification_ScheduleRichPushNotificationUTCAsync | Schedules a rich push notification to a user |
| PushNotification_SendNormalizedPushNotificationAsync | Sends a notification to a user consisting of alert content and custom data. |
| PushNotification_SendNormalizedPushNotificationBatchAsync | |
| PushNotification_SendNormalizedPushNotificationToGroupAsync | Sends a notification to a "group" of user based on a brainCloud portal configured notification template.
Includes JSON defining the substitution params to use with the template.
See the Portal documentation for more info. |
| PushNotification_SendRawPushNotificationAsync | Sends a raw push notification to a target user. |
| PushNotification_SendRawPushNotificationBatchAsync | |
| PushNotification_SendRawPushNotificationToGroupAsync | Sends a raw push notification to a target group. |
| PushNotification_SendRichPushNotificationAsync | Sends a notification to a user based on a brainCloud portal configured notification template.
NOTE: It is possible to send a push notification to oneself. |
| PushNotification_SendRichPushNotificationWithParamsAsync | Sends a notification to a user based on a brainCloud portal configured notification template.
Includes JSON defining the substitution params to use with the template.
See the Portal documentation for more info.
NOTE: It is possible to send a push notification to oneself. |
| PushNotification_SendSimplePushNotificationAsync | Sends a simple push notification based on the passed in message.
NOTE: It is possible to send a push notification to oneself. |
| PushNotification_SendTemplatedPushNotificationToGroupAsync | Sends a notification to a "group" of user based on a brainCloud portal configured notification template.
Includes JSON defining the substitution params to use with the template.
See the Portal documentation for more info. |
| Script_CancelScheduledScriptAsync | Cancels a scheduled cloud code script |
| Script_RunParentScriptAsync | Run a cloud script in a parent app |
| Script_RunPeerScriptAsync | Runs a script from the context of a peer |
| Script_RunPeerScriptAsynchAsync | Runs a script asynchronously from the context of a peer
This operation does not wait for the script to complete before returning |
| Script_RunScriptAsync | Executes a script on the server. |
| Script_ScheduleRunScriptMinutesAsync | Allows cloud script executions to be scheduled |
| Script_ScheduleRunScriptUTCAsync | |
| Shopping_AddToCart_ISFOAsync | |
| Shopping_AddToCart_SISFOAsync | Add a product to the player's shopping cart. |
| Shopping_AddToWishlistAsync | Add an item to the player's wishlist. |
| Shopping_EmptyCartAsync | Empty the player's shopping cart. |
| Shopping_EmptyWishlistAsync | Remove all items from the player's wishlist. |
| Shopping_FunnyUserReviewAsync | @2222188570 |
| Shopping_GetCartAsync | Retrieve the player's current shopping cart. |
| Shopping_GetFeaturedProductsAsync | Return a list of featured products. |
| Shopping_GetMyLibraryAsync | @2304250631 |
| Shopping_GetMyOrdersAsync | @919332756 |
| Shopping_GetMyUserTagsAsync | @274383141 |
| Shopping_GetMyWishlistAsync | Returns the current player's wishlist. |
| Shopping_GetPopularProductsAsync | Return a list of the mos tpopular products. |
| Shopping_GetPopularTagsAsync | @1350446922 |
| Shopping_GetProductAsync | @2681224790 |
| Shopping_GetProductsByTagAsync | @3387279661 |
| Shopping_GetProductsByTagsAsync | |
| Shopping_GetRecentlyCreatedProductsAsync | Return a list of recently created products. |
| Shopping_GetRecentlyUpdatedProductsAsync | Return a list of recently updated products. |
| Shopping_GetRecommendedProductsAsync | @2681224790 |
| Shopping_GetSpecialOffersAsync | Return a list of special offers. |
| Shopping_GetUserReviewsAsync | Get a list of user reviews for a product. |
| Shopping_GetUserTagsAsync | @1777617418 |
| Shopping_GetWishlistAsync | Returns the specified player's wishlist. |
| Shopping_LikeUserReviewAsync | @3972606582 |
| Shopping_RemoveFromCartAsync | Remove an item from the player's shopping cart. |
| Shopping_RemoveFromWishlist_ISFOAsync | |
| Shopping_RemoveFromWishlist_SSFOAsync | Remove an item from the player's wishlist. |
| Shopping_RemoveUserTagAsync | @2944656417 |
| Shopping_SubmitUserReviewAsync | Submit a user review of a product. |
| Shopping_SubmitUserTagAsync | @3717774610 |
| Shopping_SubmitUserTagsAsync | |
| Shopping_UnfunnyUserReviewAsync | @2806051775 |
| Shopping_UnlikeUserReviewAsync | @594218927 |
| SocialFeed_BlockPlayerAsync | |
| SocialFeed_GetActivityAsync | |
| SocialFeed_GetCommentAsync | |
| SocialFeed_HidePlayerAsync | |
| SocialFeed_LikeActivityAsync | |
| SocialFeed_LikeCommentAsync | |
| SocialFeed_PostCommentAsync | |
| SocialFeed_PostCommentReplyAsync | |
| SocialFeed_ReadCommentRepliesAsync | |
| SocialFeed_ReadCommentsAsync | |
| SocialFeed_ReadFilteredSocialFeedAsync | |
| SocialFeed_ReadFriendsSocialFeedAsync | |
| SocialFeed_ReadSocialFeedAsync | |
| SocialFeed_SetFeedVisibilityAsync | |
| SocialFeed_ShareAchievementAsync | |
| SocialFeed_ShareAppAsync | |
| SocialFeed_ShareChannelAsync | |
| SocialFeed_ShareGameGuideAsync | |
| SocialFeed_ShareLinkAsync | |
| SocialFeed_ShareScreenshotAsync | |
| SocialFeed_ShareVideoAsync | |
| SocialFeed_UnblockPlayerAsync | |
| SocialFeed_UnhidePlayerAsync | |
| SocialFeed_UnlikeActivityAsync | |
| SocialFeed_UnlikeCommentAsync | |
| SocialLeaderboard_GetGlobalLeaderboardEntryCountAsync | Gets the number of entries in a global leaderboard |
| SocialLeaderboard_GetGlobalLeaderboardEntryCountByVersionAsync | Gets the number of entries in a global leaderboard |
| SocialLeaderboard_GetGlobalLeaderboardPageAsync | |
| SocialLeaderboard_GetGlobalLeaderboardPageByVersionAsync | |
| SocialLeaderboard_GetGlobalLeaderboardVersionsAsync | Gets the global leaderboard versions. |
| SocialLeaderboard_GetGlobalLeaderboardViewAsync | |
| SocialLeaderboard_GetGlobalLeaderboardViewByVersionAsync | |
| SocialLeaderboard_GetGroupSocialLeaderboardAsync | Retrieve the social leaderboard for a group. |
| SocialLeaderboard_GetMultiSocialLeaderboardAsync | |
| SocialLeaderboard_GetPlayerScoreAsync | Gets a player's score from a leaderboard |
| SocialLeaderboard_GetPlayerScoresFromLeaderboardsAsync | |
| SocialLeaderboard_GetPlayersSocialLeaderboardAsync | |
| SocialLeaderboard_GetSocialLeaderboardAsync | Method returns the social leaderboard. A player's social leaderboard is
comprised of players who are recognized as being your friend.
For now, this applies solely to Facebook connected players who are
friends with the logged in player (who also must be Facebook connected).
In the future this will expand to other identification means (such as
Game Centre, Google circles etc).
Leaderboards entries contain the player's score and optionally, some user-defined
data associated with the score. The currently logged in player will also
be returned in the social leaderboard.
Note: If no friends have played the game, the bestScore, createdAt, updatedAt
will contain NULL. |
| SocialLeaderboard_ListLeaderboardsAsync | Retrieve a list of all leaderboards |
| SocialLeaderboard_PostScoreToDynamicLeaderboardAsync | |
| SocialLeaderboard_PostScoreToDynamicLeaderboardDaysAsync | |
| SocialLeaderboard_PostScoreToLeaderboardAsync | Post the players score to the given social leaderboard.
You can optionally send a user-defined json string of data
with the posted score. This string could include information
relevant to the posted score.
Note that the behaviour of posting a score can be modified in
the brainCloud portal. By default, the server will only keep
the player's best score. |
| SocialLeaderboard_RemovePlayerScoreAsync | Removes a player's score from the leaderboard |
| Telemetry_EndTelemetryEventAsync | |
| Telemetry_EndTelemetrySessionAsync | |
| Telemetry_LogTelemetryEventAsync | |
| Telemetry_StartTelemetryEventAsync | |
| Telemetry_StartTelemetrySessionAsync | |
| Time_ReadServerTimeAsync | Method returns the server time in UTC. This is in UNIX millis time format.
For instance 1396378241893 represents 2014-04-01 2:50:41.893 in GMT-4. |
| Tournament_ClaimTournamentRewardAsync | Processes any outstanding rewards for the given player |
| Tournament_GetTournamentStatusAsync | Get tournament status associated with a leaderboard |
| Tournament_JoinTournamentAsync | Join the specified tournament.
Any entry fees will be automatically collected. |
| Tournament_LeaveTournamentAsync | Removes player's score from tournament leaderboard |
| Tournament_PostTournamentScoreAsync | |
| Tournament_PostTournamentScoreWithResultsAsync | |
| Tournament_ViewCurrentRewardAsync | Returns the user's expected reward based on the current scores |
| Tournament_ViewRewardAsync | Returns the user's reward from a finished tournament |
See Also