Client
Overview
The BrainCloudClient class is the core of the brainCloud API. From the BrainCloudClient you can access all of brainCloud's services (Authentication, Entity, etc) and from there the individual API's they contain.
The Client also contains many setup and configuration methods for timeouts, global callbacks, and more.
API Summary
Critical
Functions that are necessary to use the brianCloud library.
Callbacks
Functions to register and deregister callbacks for specific events.
Timeouts
Functions to configure network timeouts.
- SetPacketTimeoutsToDefault
- GetPacketTimeouts
- SetPacketTimeouts
- GetAuthenticationPacketTimeout
- SetAuthenticationPacketTimeout
Status
Functions to query the client state or reset network communications.
- IsAuthenticated
- IsInitialized
- GetSessionId
- ResetCommunication
- InsertEndOfMessageBundleMarker
- OverrideCountryCode
- OverrideLanguageCode
- EnableLogging
File Upload
Functions to register for file upload callbacks and configure upload specific timeouts.
- RegisterFileUploadCallback
- DeregisterFileUploadCallback
- GetUploadLowTransferRateThreshold
- SetUploadLowTransferRateThreshold
- GetUploadLowTransferRateTimeout
- SetUploadLowTransferRateTimeout
Network Error Caching
Functions to enable and manage network error message caching.
Global Error Logging
Functions to register and deregister callbacks for all error events.
Compatibility
Compatibility settings for older brainCloud versions.
📄️ DeregisterEventCallback
Overview
📄️ DeregisterFileUploadCallback
Overview
📄️ DeregisterGlobalErrorCallback
Overview
📄️ DeregisterNetworkErrorCallback
Overview
📄️ DeregisterRewardCallback
Overview
📄️ EnableCompressedRequests
Overview
📄️ EnableCompressedResponses
Overview
📄️ EnableLogging
Overview
📄️ EnableNetworkErrorMessageCaching
Overview
📄️ FlushCachedMessages
Overview
📄️ GetAppId
Overview
📄️ GetAppVersion
Overview
📄️ GetAuthenticationPacketTimeout
Overview
📄️ GetPacketTimeouts
Overview
📄️ GetSessionId
Overview
📄️ GetUploadLowTransferRateThreshold
Overview
📄️ GetUploadLowTransferRateTimeout
Overview
📄️ Initialize
Overview
📄️ InitializeIdentity
Overview
📄️ InsertEndOfMessageBundleMarker
Overview
📄️ IsAuthenticated
Overview
📄️ IsInitialized
Overview
📄️ OverrideCountryCode
Overview
📄️ OverrideLanguageCode
Overview
📄️ RegisterEventCallback
Overview
📄️ RegisterFileUploadCallback
Overview
📄️ RegisterGlobalErrorCallback
Overview
📄️ RegisterNetworkErrorCallback
Overview
📄️ RegisterRewardCallback
Overview
📄️ ResetCommunication
Overview
📄️ RetryCachedMessages
Overview
📄️ RunCallbacks
Overview
📄️ SetAuthenticationPacketTimeout
Overview
📄️ SetErrorCallbackOn202Status
Overview
📄️ SetOldStyleStatusMessageErrorCallback
Overview
📄️ SetPacketTimeouts
Overview
📄️ SetPacketTimeoutsToDefault
Overview
📄️ SetUploadLowTransferRateThreshold
Overview
📄️ SetUploadLowTransferRateTimeout
Overview
📄️ Update
Overview