API Reference

C# C++ Objective-C Java JavaScript Cloud Code Raw

x

Introduction

BrainCloudWrapper

Client API

Authentication
- AuthenticateAnonymous
- AuthenticateApple
- AuthenticateEmailPassword
- AuthenticateExternal
- AuthenticateFacebook
- AuthenticateGameCenter
- AuthenticateGoogle
- AuthenticateGoogleOpenId
- AuthenticateHandoff
- AuthenticateParse
- AuthenticateSettopHandoff
- AuthenticateSteam
- AuthenticateTwitter
- AuthenticateUniversal
- ClearSavedProfileId
- GenerateAnonymousId
- Initialize
- ResetEmailPasswordAdvancedWithExpiry
- ResetEmailPasswordWithExpiry
- ResetUniversalIdPasswordAdvancedWithExpiry
- ResetUniversalIdPasswordWithExpiry
App Store
- FinalizePurchase
- GetEligiblePromotions
- GetSalesInventory
- GetSalesInventoryByCategory
- StartPurchase
- VerifyPurchase
Async Match
- AbandonMatch
- AbandonMatchWithSummaryData
- CompleteMatch
- CompleteMatchWithSummaryData
- CreateMatch
- CreateMatchWithInitialTurn
- DeleteMatch
- FindCompleteMatches
- FindMatches
- ReadMatch
- ReadMatchHistory
- SubmitTurn
- UpdateMatchSummaryData
Chat
- ChannelConnect
- ChannelDisconnect
- DeleteChatMessage
- GetChannelId
- GetChannelInfo
- GetChatMessage
- GetRecentChatMessages
- GetSubscribedChannels
- PostChatMessage
- PostChatMessageSimple
- SysCreateChannel
- SysDeleteChannel
- SysDeleteChatMessage
- SysGetChannelInfo
- SysGetChatMessage
- SysGetRecentChatMessages
- SysPostChatMessage
- SysPostChatMessageSimple
- SysUpdateChatMessage
- UpdateChatMessage
Client
- DeregisterEventCallback
- DeregisterFileUploadCallback
- DeregisterGlobalErrorCallback
- DeregisterNetworkErrorCallback
- DeregisterRewardCallback
- EnableLogging
- EnableNetworkErrorMessageCaching
- FlushCachedMessages
- GetAuthenticationPacketTimeout
- GetPacketTimeouts
- GetSessionId
- GetUploadLowTransferRateThreshold
- GetUploadLowTransferRateTimeout
- Initialize
- InitializeIdentity
- InsertEndOfMessageBundleMarker
- IsAuthenticated
- IsInitialized
- OverrideCountryCode
- OverrideLanguageCode
- RegisterEventCallback
- RegisterFileUploadCallback
- RegisterGlobalErrorCallback
- RegisterNetworkErrorCallback
- RegisterRewardCallback
- ResetCommunication
- RetryCachedMessages
- RunCallbacks
- SetAuthenticationPacketTimeout
- SetErrorCallbackOn202Status
- SetOldStyleStatusMessageErrorCallback
- SetPacketTimeouts
- SetPacketTimeoutsToDefault
- SetUploadLowTransferRateThreshold
- SetUploadLowTransferRateTimeout
- Update
Custom Entity
- CreateEntity
- DeleteEntity
- GetCount
- GetEntityPage
- GetEntityPageOffset
- ReadEntity
- SysCreateCollection
- SysCreateEntity
- SysCreateIndex
- SysDeleteEntity
- SysDropCollection
- SysDropIndex
- SysGetCount
- SysGetEntityPage
- SysGetEntityPageOffset
- SysListCollections
- SysListIndexes
- ReadEntity
- SysUpdateCollectionMigrate
- SysUpdateEntity
- SysUpdateEntityFields
- SysUpdateEntityOwner
- UpdateEntity
- UpdateEntityFields
Data Stream
- CustomPageEvent
- CustomScreenEvent
- CustomTrackEvent
- SubmitCrashReport
Entity
- CreateEntity
- DeleteEntity
- DeleteSingleton
- GetEntitiesByType
- GetEntity
- GetList
- GetListCount
- GetPage
- GetPageOffset
- GetSharedEntitiesForProfileId
- GetSharedEntitiesListForProfileId
- GetSharedEntityForProfileId
- GetSingleton
- IncrementSharedUserEntityData
- IncrementUserEntityData
- UpdateEntity
- UpdateSharedEntity
- UpdateSingleton
Event
- DeleteIncomingEvent
- GetEvents
- SendEvent
- UpdateIncomingEventData
File
- CancelUpload
- DeleteUserFile
- DeleteUserFiles
- GetCDNUrl
- GetUploadBytesTransferred
- GetUploadProgress
- GetUploadTotalBytesToTransfer
- ListUserFiles
- PrepareUserUpload - CloudCode and JavaScript
- UploadFile - JavaScript
- UploadFile
Friend
- AddFriends
- FindUserByExactUniversalId
- FindUsersByExactName
- FindUsersByNameStartingWith
- FindUsersBySubstrName
- FindUsersByUniversalIdStartingWith
- FindUsersByUserSummary
- GetExternalIdForProfileId
- GetProfileInfoForCredential
- GetProfileInfoForExternalAuthId
- GetSummaryDataForProfileId
- GetUsersOnlineStatus
- ListFriends
- ReadFriendEntity
- ReadFriendsEntities
- ReadFriendUserState
- RemoveFriends
Gamification
- AwardAchievements
- ReadAchievedAchievements
- ReadAchievements
- ReadAllGamification
- ReadCompletedMilestones
- ReadCompletedQuests
- ReadInProgressMilestones
- ReadInProgressQuests
- ReadMilestones
- ReadMilestonesByCategory
- ReadNotStartedQuests
- ReadQuests
- ReadQuestsByCategory
- ReadQuestsWithBasicPercentage
- ReadQuestsWithComplexPercentage
- ReadQuestsWithStatus
- ReadXpLevelsMetaData
- ResetAllQuestsAndMilestones
- ResetMilestones
- ResetQuests
- SysAddQuestTask
- SysCreateMilestone
- SysCreateQuest
- SysDeleteMilestone
- SysDeleteQuest
- SysDeleteQuestTask
- SysGetMilestonePage
- SysGetMilestonePageOffset
- SysGetQuestPage
- SysGetQuestPageOffset
- SysReadMilestone
- SysReadQuest
- SysReorderQuestTasks
- SysUpdateMilestone
- SysUpdateQuest
- SysUpdateQuestTask
- UpdateRewards
Global App
- ReadProperties
- SysGetDailyCounts
- SysGetMonthlyCounts
- SysUpdatePropertyJson
- SysUpdatePropertyString
Global Entity
- CreateEntity
- CreateEntityWithIndexedId
- CreateSystemEntity
- CreateSystemEntityWithIndexedId
- DeleteEntity
- DeleteSystemEntity
- GetList
- GetListByIndexedId
- GetListCount
- GetPage
- GetPageOffset
- GetRandomEntitiesMatching
- GetSystemEntityList
- GetSystemEntityListCount
- GetSystemEntityPage
- GetSystemEntityPageOffset
- IncrementGlobalEntityData
- MakeSystemEntity
- ReadEntity
- ReadSystemEntity
- UpdateEntity
- UpdateEntityAcl
- UpdateEntityIndexedId
- UpdateEntityOwnerAndAcl
- UpdateEntityTimeToLive
- UpdateSystemEntity
- UpdateSystemEntityAcl
Global Statistics
- IncrementGlobalStats
- ProcessStatistics
- ReadAllGlobalStats
- ReadGlobalStatsForCategory
- ReadGlobalStatsSubset
Group
- AcceptGroupInvitation
- AddGroupMember
- ApproveGroupJoinRequest
- AutoJoinGroup
- AutoJoinGroupMulti
- CancelGroupInvitation
- CreateGroup
- CreateGroupEntity
- CreateGroupWithSummaryData
- DeleteGroup
- DeleteGroupEntity
- GetMyGroups
- GetRandomGroupsMatching
- IncrementGroupData
- IncrementGroupEntityData
- InviteGroupMember
- JoinGroup
- LeaveGroup
- ListGroupsPage
- ListGroupsPageByOffset
- ListGroupsWithMember
- ReadGroup
- ReadGroupData
- ReadGroupEntitiesPage
- ReadGroupEntitiesPageByOffset
- ReadGroupEntity
- ReadGroupMembers
- RejectGroupInvitation
- RejectGroupJoinRequest
- RemoveGroupMember
- SetGroupOpen
- SysChangeGroupType
- UpdateGroupAcl
- UpdateGroupData
- UpdateGroupEntityData
- UpdateGroupMember
- UpdateGroupName
- UpdateGroupSummaryData
Identity
- Attach
- AttachAppleIdentity
- AttachBlockchainIdentity
- AttachEmailIdentity
- AttachFacebookIdentity
- AttachGameCenterIdentity
- AttachGoogleIdentity
- AttachGoogleOpenIdIdentity
- AttachNonLoginUniversalId
- AttachParentWithIdentity
- AttachParseIdentity
- AttachPeerProfile
- AttachSteamIdentity
- AttachTwitterIdentity
- AttachUniversalIdentity
- ChangeEmailIdentity
- CreateHandoffId
- CreateSettopHandoffCode
- Detach
- DetachAppleIdentity
- DetachBlockchainIdentity
- DetachEmailIdentity
- DetachFacebookIdentity
- DetachGameCenterIdentity
- DetachGoogleIdentity
- DetachGoogleOpenIdIdentity
- DetachParent
- DetachParseIdentity
- DetachPeer
- DetachSteamIdentity
- DetachTwitterIdentity
- DetachUniversalIdentity
- GetChildProfiles
- GetExpiredIdentities
- GetIdentities
- GetPeerProfiles
- Merge
- MergeAppleIdentity
- MergeEmailIdentity
- MergeFacebookIdentity
- MergeGameCenterIdentity
- MergeGoogleIdentity
- MergeGoogleOpenIdIdentity
- MergeParseIdentity
- MergePeerProfile
- MergeSteamIdentity
- MergeTwitterIdentity
- MergeUniversalIdentity
- RefreshIdentity
- SwitchToChildProfile
- SwitchToParentProfile
- SwitchToSingletonChildProfile
- UpdateUniversalIdLogin
- VerifyOktaJWT
Item Catalog
- GetCatalogItemDefinition
- GetCatalogItemsPage
- GetCatalogItemsPageOffset
- SysAddCatalogItem
- SysEditCatalogItem
- SysPublishCatalogItem
- SysRetireCatalogItem
- SysRevokeCatalogItem
Leaderboard
- CreateLeaderboard
- DeleteLeaderboards
- EditLeaderboard
- GetGlobalLeaderboardEntryCount
- GetGlobalLeaderboardEntryCountByVersion
- GetGlobalLeaderboardPage
- GetGlobalLeaderboardPageByVersion
- GetGlobalLeaderboardVersions
- GetGlobalLeaderboardView
- GetGlobalLeaderboardViewByVersion
- GetGroupLeaderboardView
- GetGroupLeaderboardViewByVersion
- GetGroupSocialLeaderboard
- GetGroupSocialLeaderboardByVersion
- GetMultiSocialLeaderboard
- GetPlayerScore
- GetPlayerScoresFromLeaderboards
- GetPlayersSocialLeaderboard
- GetPlayersSocialLeaderboardByVersion
- GetSocialLeaderboard
- GetSocialLeaderboardByVersion
- ListAllLeaderboards
- PostScoreToDynamicGroupLeaderboard
- PostScoreToDynamicLeaderboard
- PostScoreToDynamicLeaderboardDays
- PostScoreToGroupLeaderboard
- PostScoreToLeaderboard
- PostScoreToLeaderboardOnBehalfOf
- RemoveGroupScore
- RemovePlayerScore
- SysResetNeverLeaderboard
Lobby
- CancelFindRequest
- CreateLobby
- CreateLobbyWithPingData
- FindLobby
- FindLobbyWithPingData
- FindOrCreateLobby
- FindOrCreateLobbyWithPingData
- GetLobbyData
- GetRegionsForLobbies
- JoinLobby
- JoinLobbyWithPingData
- LeaveLobby
- PingRegions
- RemoveMember
- SendSignal
- SwitchTeam
- SysDisbandLobby
- SysRoomCancelled
- SysRoomReady
- SysSendSignal
- UpdateReady
- UpdateSettings
Mail
- SendAdvancedEmail
- SendAdvancedEmailByAddress
- SendBasicEmail
Matchmaking
- Matchmaking Filters
- DecrementPlayerRating
- DisableMatchMaking
- EnableMatchMaking
- FindPlayers
- FindPlayersUsingFilter
- FindPlayersUsingScript
- FindPlayersWithAttributes
- FindPlayersWithAttributesUsingFilter
- FindPlayersWithAttributesUsingScript
- GetShieldExpiry
- IncrementPlayerRating
- IncrementShieldOnFor
- Read
- ResetPlayerRating
- SetPlayerRating
- TurnShieldOff
- TurnShieldOn
- TurnShieldOnFor
Messaging
- DeleteMessages
- GetMessageBoxes
- GetMessageCounts
- GetMessages
- GetMessagesPage
- GetMessagesPageOffset
- MarkMessagesRead
- SendMessage
- SendMessageSimple
- SysDeleteMessage
- SysGetMessages
- SysGetMessagesPage
- SysGetMessagesPageOffset
- SysSendMessage
- SysSendMessageSimple
- SysUpdateMessage
One-Way Match
- CancelMatch
- CompleteMatch
- StartMatch
Playback Stream
- AddEvent
- DeleteStream
- EndStream
- GetRecentStreamsForInitiatingPlayer
- GetRecentStreamsForTargetPlayer
- ReadStream
- StartStream
Player State
- ClearUserStatus
- DeleteUser
- ExtendUserStatus
- GetAttributes
- GetUserStatus
- Logout
- ReadUserState
- RemoveAttributes
- ResendValidationEmail
- ResetUser
- SetUserStatus
- UpdateAttributes
- UpdateContactEmail
- UpdateIsTester
- UpdateLanguageCode
- UpdateSummaryFriendData
- UpdateTimezoneOffset
- UpdateUserName
- UpdateUserPictureUrl
Player Statistics
- GetNextExperienceLevel
- IncrementExperiencePoints
- IncrementUserStats
- ProcessStatistics
- ReadAllUserStats
- ReadUserStatsForCategory
- ReadUserStatsSubset
- ResetAllUserStats
- SetExperiencePoints
Player Statistics Event
- TriggerStatsEvent
- TriggerStatsEvents
Presence
- ForcePush
- GetPresenceOfFriends
- GetPresenceOfGroup
- GetPresenceOfUsers
- RegisterListenersForFriends
- RegisterListenersForGroup
- RegisterListenersForProfiles
- SetVisibility
- StopListening
- SysExtendPxExpiry
- SysInitializePresence
- SysTerminatePresence
- UpdateActivity
Product
- AwardCurrency
- AwardParentCurrency
- AwardPeerCurrency
- ConfirmFacebookPurchase
- ConfirmGooglePlayPurchase
- ConsumeCurrency
- ConsumeParentCurrency
- ConsumePeerCurrency
- FinalizeSteamTransaction
- GetCurrency
- GetEligiblePromotions
- GetParentCurrency
- GetSalesInventory
- GetSalesInventoryByCategory
- ResetCurrency
- ResetParentCurrency
- StartSteamTransaction
- VerifyItunesReceipt
- VerifyMicrosoftReceipt
Profanity
- ProfanityCheck
- ProfanityIdentifyBadWords
- ProfanityReplaceText
Push Notification
- DeregisterAllPushNotificationDeviceTokens
- DeregisterPushNotificationDeviceToken
- RegisterPushNotificationDeviceToken
- ScheduleNormalizedPushNotificationMinutes
- ScheduleNormalizedPushNotificationUTC
- ScheduleRawPushNotificationMinutes
- ScheduleRawPushNotificationUTC
- ScheduleRichPushNotificationMinutes
- ScheduleRichPushNotificationUTC
- SendNormalizedPushNotification
- SendNormalizedPushNotificationBatch
- SendNormalizedPushNotificationToGroup
- SendRawPushNotification
- SendRawPushNotificationBatch
- SendRawPushNotificationToGroup
- SendRichPushNotification
- SendRichPushNotificationWithParams
- SendSimplePushNotification
- SendTemplatedPushNotificationToGroup
Redemption Code
- GetRedeemedCodes
- RedeemCode
Relay
- Connect
- DeregisterDataCallback
- Disconnect
- LastPing
- NetId
- RegisterDataCallback
- Send
- SetPingInterval
RTT
- DeregisterAllRTTCallbacks
- DeregisterRTTChatCallback
- DeregisterRTTEventCallback
- DeregisterRTTLobbyCallback
- DeregisterRTTMessagingCallback
- DisableRTT
- EnableRTT
- IsRTTEnabled
- RegisterRTTChatCallback
- RegisterRTTEventCallback
- RegisterRTTLobbyCallback
- RegisterRTTMessagingCallback
S3 Handling
- GetCDNUrl
- GetFileList
- GetUpdatedFiles
Script
- CancelScheduledScript
- GetRunningOrQueuedCloudScripts
- GetScheduledCloudScripts
- RunParentScript
- RunPeerScript
- RunPeerScriptAsync
- RunScript
- ScheduleRunScriptMinutes
- ScheduleRunScriptUTC
Time
- ReadServerTime
Tournament
- ClaimTournamentReward
- GetDivisionInfo
- GetMyDivisions
- GetTournamentStatus
- JoinDivision
- JoinTournament
- LeaveDivisionInstance
- LeaveTournament
- PostTournamentScore
- PostTournamentScoreOnBehalfOf
- PostTournamentScoreWithResults
- ViewCurrentReward
- ViewReward
User
- SysCreateUserEmailPassword
- SysCreateUserExternalAuth
- SysCreateUserUniversalId
- SysGetPage
- SysGetPageOffset
- SysSendPasswordResetEmailAdvancedWithExpiry
- SysSendPasswordResetEmailWithExpiry
- SysSendPasswordResetUniversalIdAdvancedWithExpiry
- SysSendPasswordResetUniversalIdWithExpiry
User Items
- AwardUserItem
- DropUserItem
- GetUserItem
- GetUserItemsPage
- GetUserItemsPageOffset
- GiveUserItemTo
- PublishUserItemToBlockchain
- PurchaseUserItem
- ReceiveUserItemFrom
- RefreshBlockchainUserItems
- SellUserItem
- UpdateUserItemData
- UseUserItem
Virtual Currency
- AwardCurrency
- AwardParentCurrency
- AwardPeerCurrency
- ConsumeCurrency
- ConsumeParentCurrency
- ConsumePeerCurrency
- GetCurrency
- GetParentCurrency
- GetPeerCurrency
- ResetCurrency
- ResetParentCurrency
- ResetPeerCurrency

Cloud Code

Writing Scripts
Bridge
HTTP Client
Logging
Peer Bridge

Server to Server (S2S)

Cloud Code Bridge
- CallAPI
- CallScript
- GetAppId
- GetClientAppId
- GetEventServiceProxy
- GetGlobalProperty
- GetHttpClientServiceProxy
- GetLeaderboardServiceProxy
- GetLogServiceProxy
- GetPushNotificationServiceProxy
- GetRedemptionCodeServiceProxy
- GetScriptServiceProxy
- GetSessionForCredential
- GetSessionForProfile
- IsClientBridge
- IsPeerBridge
- IsServerBridge
Authentication
- Authenticate
Chat
- GetChannelId
- SysCreateChannel
- SysDeleteChannel
- SysDeleteChatMessage
- SysGetChannelInfo
- SysGetChatMessage
- SysGetRecentChatMessages
- SysPostChatMessage
- SysPostChatMessageSimple
- SysUpdateChatMessage
Custom Entity
- SysCreateCollection
- SysCreateIndex
- SysDropIndex
- SysListCollections
- SysListIndexes
Event
- SendEvent
Global App
- ReadProperties
Global Entity
- CreateSystemEntity
- CreateSystemEntityWithIndexedId
- DeleteSystemEntity
- GetList
- GetListByIndexedId
- GetListCount
- GetPage
- GetPageOffset
- GetSystemEntityList
- GetSystemEntityListCount
- GetSystemEntityPage
- GetSystemEntityPageOffset
- ReadEntity
- ReadSystemEntity
- UpdateEntityIndexedId
- UpdateSystemEntity
- UpdateSystemEntityAcl
Global Statistics
- IncrementGlobalStats
- ProcessStatistics
- ReadAllGlobalStats
- ReadGlobalStatsForCategory
- ReadGlobalStatsSubset
Group
- SysChangeGroupType
Heartbeat
- Heartbeat
HTTP Client
- GetResponseJson
- GetResponseText
- PostFormResponseJson
- PostFormResponseText
- PostJsonOffboard
- PostJsonResponseJson
- PostJsonResponseText
- PostTextResponseText
Item Catalog
- SysAddCatalogItem
- SysEditCatalogItem
- SysGetCatalogItemDefinition
- SysGetCatalogItemsPage
- SysGetCatalogItemsPageOffset
- SysPublishCatalogItem
- SysRetireCatalogItem
- SysRevokeCatalogItem
- SysSetInvisibleCatalogItem
Leaderboard
- CreateLeaderboard
- DeleteLeaderboards
- EditLeaderboard
- GetGlobalLeaderboardEntryCount
- GetGlobalLeaderboardPage
- GetGlobalLeaderboardPageByVersion
- GetGlobalLeaderboardVersions
- ListAllLeaderboards
- PostScoreToLeaderboardOnBehalfOf
Lobby
- GetLobbyData
- SysDisbandLobby
- SysRoomCancelled
- SysRoomReady
- SysSendSignal
Logging
- LogError
- LogErrorJson
- LogInfo
- LogInfoJson
- LogWarning
- LogWarningJson
Mail
- SendAdvancedEmail
- SendAdvancedEmailByAddress
- SendBasicEmail
Messaging
- SysDeleteMessage
- SysGetMessages
- SysGetMessagesPage
- SysGetMessagesPageOffset
- SysSendMessage
- SysSendMessageSimple
- SysUpdateMessage
Presence
- ForcePush
- GetPresenceOfFriends
- GetPresenceOfGroup
- GetPresenceOfUsers
- RegisterListenersForFriends
- RegisterListenersForGroup
- RegisterListenersForProfiles
- SetVisibility
- StopListening
- SysExtendPxExpiry
- SysInitializePresence
- SysTerminatePresence
- UpdateActivity
Push Notifications
- GetAllSegments
- ScheduleNormalizedPushNotifications
- ScheduleRawPushNotifications
- ScheduleRichPushNotifications
- SendNormalizedPushNotificationBatch
- SendNormalizedPushNotificationToGroup
- SendNormalizedToSegments
- SendRawPushNotificationBatch
- SendRawPushNotificationToGroup
- SendRawToSegments
- SendRichToSegments
- SendSimple
- SendTemplatedPushNotificationToGroup
Redemption Codes
- ActivateCode
- AddCode
- InvalidateCode
- UpdateCustomInfo
Script
- CancelScheduledScript
- GetRunningOrQueuedCloudScripts
- GetScheduledCloudScripts
- RunBatchUserScript
- ScheduleBatchUserScript
- ScheduleCloudScript
Time
- ReadServerTime
Tournament
- GetTournamentConfigs
- PostTournamentScoreOnBehalfOf

Appendix

ACL
Authentication Types
Generic Paged Queries
- Pagination
- Searching
- Sorting
- Output
- Usage
Platform IDs
Store Platform IDs
Reason Codes
Statistics Grammar
Versioning
MongoDB Where Queries

C# C++ Objective-C Java JavaScript Cloud Code Raw

C# C++ Objective-C Java JavaScript Cloud Code Raw