BrainCloud 4.9.0

BrainCloud 4.9.0

TestsTested
LangLanguage Objective C++Objective C++
License Apache-2.0
ReleasedLast Release Oct 2021

Maintained by Jonathan McCaffrey, David St-Louis, Ryan.



brainCloud Objective-C/Swift Library

Thanks for downloading the brainCloud Objective-C/Swift client library! Here are a few notes to get you started. Further information about the brainCloud API, including example Tutorials can be found here:

http://getbraincloud.com/apidocs/

If you haven't signed up or you want to log into the brainCloud portal, you can do that here:

https://portal.braincloudservers.com/

Releases

Package Description
Cocoapod Cocoapod for AppleTV, iOS, OSX
brainCloudClient_ObjC_X.X.X.X.zip Apple libraries for AppleTV, iOS, OSX

Example Projects

Examples of using brainCloud in your Swift Projects can be found here.

Installation

The library is distributed through CocoaPods. In order to install the library, simply add the following to your Podfile.

pod 'BrainCloud'

Note that if you're using Cocoapods 1.0.0 and the use_frameworks! flag, please refer to the project setup page for additional information:

http://getbraincloud.com/apidocs/tutorials/objective-c-tutorials/

If you're a newcomer to the CocoaPods world, you can find documentation on how to set up your Xcode project here:

https://guides.cocoapods.org/

Troubleshooting

Here are a few common errors that you may see on your first attempt to connect to brainCloud.

  • App id not set: Verify you've set up the app id and app secret correctly in the initialize() method.
  • Platform not enabled: Verify you've enabled your platform on the portal.

If you're still having issues, log into the portal and give us a shout through the help system (bottom right icon with the question mark and chat bubble).

brainCloud Summary

brainCloud is a ready-made back-end platform for the development of feature-rich games, apps and things. brainCloud provides the features you need – along with comprehensive tools to support your team during development, testing and user support.

brainCloud consists of:

  • Cloud Service – an advanced, Software-as-a-Service (SaaS) back-end
  • Client Libraries – local client libraries (SDKs)
  • Design Portal – a portal that allows you to design and debug your apps
  • brainCloud Architecture

architecture

What's the difference between the brainCloud Wrapper and the brainCloud Client?

The wrapper contains quality of life improvement around the brainCloud Client. It may contain device specific code, such as serializing the user's login id on an Android or iOS device. It is recommended to use the wrapper by default.

wrapper

How do I initialize brainCloud?

If using the wrapper use the following code.

_bc = [[BrainCloudWrapper alloc] init]; // optionally pass in a _wrapperName
[_bc initialize: @"https://sharedprod.braincloudservers.com/dispatcherv2"
      secretKey:_secret
          appId:_appId
        version:_version
     companyName:_company
         appName:_appName];

Your _appId, _secret, is set on the brainCloud dashboard. Under Design | Core App Info > Application IDs

wrapper

_wrapperName prefixes saved operations that the wrapper will make. Use a _wrapperName if you plan on having multiple instances of brainCloud running.


Newly upgraded?

If your app is already live, you should NOT specify the _wrapperName - otherwise the library will look in the wrong location for your user's stored anonymousID and profileID information. Only add a name if you intend to alter the save data.


_companyName and _appName are also used in determining the fileName. ex. bitHeads.exampleApp, or mainWrapper.bitHeads.exampleApp

_appVersion is the current version of our app. Having an _appVersion less than your minimum app version on brainCloud will prevent the user from accessing the service until they update their app to the lastest version you have provided them.

wrapper

How do I keep the brainCloud SDK updating?

In your project's update loop, you're going to want to update brainCloud client so it can check for responses.

To do this, you need to call runCallbacks.

[_bc runCallbacks];

How do I authenticate a user with brainCloud?

The simplest form of authenticating with brainCloud Wrapper is an Anonymous Authentication.

[_bc authenticateAnonymous:_successBlock errorCompletionBlock:_failureBlock cbObject:nil];

This method will create an account, and continue to use a locally saved anonymous id.

Your _successBlock and _failureBlock will contain the blocks needed to react to the brainCloud Server response.

To login with a specfic anonymous id, use the brainCloud client.

[[[_bc getBCClient] authenticationService] setAnonymousID:_anonymousId]; // re-use an Anon id
[[[_bc getBCClient] authenticationService] setAnonymousID:[[[_bc getBCClient] authenticationService] generateAnonymousId]]; // or generate a new one
[[[[_bc getBCClient] authenticationService] authenticateAnonymous:_forceCreate completionBlock:_successBlock errorCompletionBlock:_failureBlock cbObject:nil]];

Setting _forceCreate to false will ensure the user will only login to an existing account. Setting it to true, will allow the user to register a new account

How do I attach an email to a user's brainCloud profile?

After having the user create an anonymous with brainCloud, they are probably going to want to attach an email or username, so their account can be accessed via another platform, or when their local data is discarded. Attaching email authenticate would look like this.

[[_bc identityService] attachEmailIdentity:_email
                       authenticationToken:_password
                           completionBlock:_successCallback
                      errorCompletionBlock:_failureCallback
                                  cbObject:nil];

There are many authentication types. You can also merge profiles and detach idenities. See the brainCloud documentation for more information: http://getbraincloud.com/apidocs/apiref/?java#capi-auth