javascript java csharp ios

Big Bang Client SDK

The Big Bang Client SDK for iOS and OSX helps you create realtime applications in seconds! It makes event streaming and data synchronization a snap!

Installation - XCode

The Big Bang SDK is provided as a Swift Framework and is compatible with Swift and Objective-C projects for iOS and OSX. The easiest way to get started is by using Cocoapods to help manage your dependencies.

Once you have added Cocoapods to your project, add the BigBang Framework as a dependency.

Update Podfile

Add the dependency for BigBang in your Podfile

target 'MyApp' do
  pod 'BigBang', '~> 0.0.1'

Install the depndencies

Open up your terminal, switch to your workspace directory, and install.

pod install

Import the SDK

Make sure you include the proper import statements anywhere you use the SDK.

import BigBang
import SwiftyJSON


Big Bang manages your realtime infrastructure for you. Simply connect your clients and apps to your Big Bang URL. You can use to try things out. When you are ready, you can create your own application at


You will work with three resources when using Big Bang. First, you will need to manage your connection to our servers. Once you have established a connection, you will subscribe to a Channel. All shared information is scoped to a Channel. You can publish and subscribe one-time messages. If you want to give all subscribers a constantly updated state of your data, you can publish and subscribe ChannelData.


Connecting your app to Big Bang is easy.


var client = DefaultBigBangClient(appURL: "")
client?.connect({ (err) -> Void in
    if let connectErr = err  {
        println("Connection error: " + connectErr)
    else {


Connect to your Big Bang application.

Params - callback (Error)


Disconnect from the server.

client.getClientId() -> String

Your unique identifier for this session. This identifies you to the server and to other users.

Returns String clientId


client.subscribe( channelName, callback:{ (err, channel) in
    if let subscribeErr = err  {
        println("Subscribe error: " + subscribeErr)
    else {
        println("Subscribed to " +


client.disconnected({() -> Void in

disconnected( callback: DisconnectCallback ) -> Void

Fired when the client has been disconnected, either from calling disconnect() or for reasons beyond your control.


Group together multiple clients in a channel to share information. Channels are publish/subscribe. You can subscribe to a Channel to get any messages that are published to it. You can publish a message to send it to all subscribers.


var channel = client.getChannel("example-channel");

client.getChannel( name:String ) -> Channel?

Get a reference to the Channel object for the subscribed channel called name.


Returns Channel

client.subscribe("test_channel", callback: { (cerr, channel) -> Void in

    if let subscribeErr  = cerr  {
        println("Subscribe error: " + subscribeErr )
    else {
        println("Subscribed to " + channel!.name );

client.subscribe( name: String, callback: SubscribeCallback) -> Void

Subscribe to a channel called name. channel will be a Channel object.


channel.unsubscribe(Action<Void> callback)

Unsubscribe from the current channel.

channel.getSubscribers() -> [String]

Returns a [String] containing the clientIds of the current subscribers on this channel.


var json = JSON.newJSONObject()
json["message"] = "hello"


channel.publish(message:JSON) ->Void

Publish content to the channel. content must be a JSON object or array.



channel!.onMessage({ (channelMessage) in

channel.onMessage( callback: MessageCallback) ->Void

Fired when a message is received on the channel.

channel!.onJoin({(joined) in
    println("clientId " + joined + " joined the channel.")

channel.onJoin( callback: PresenceCallback) -> Void

Fired when a subscriber joins the channel.

channel!.onLeave({(left) in
    println("clientId " + left + " left the channel.")

channel.onLeave( callback: PresenceCallback ) -> Void

Fired when a subscriber leaves the channel.


ChannelData objects are used to store the state of your data. ChannelData persist as long as the Channel is active and they are automatically synchronized to all subscribers of the channel.



Get the current ChannelData namespace names as an java.util.Set<java.lang.String>.

Returns ChannelData unless no namespaces exist. Returns null if no namespaces exist.

ChannelData channelData = channel.getChannelData();

channel.getChannelData() -> ChannelData

Returns a ChannelData object for the default namespace.

ChannelData channelData = channel.getChannelData("my-namespace");

channel.getChannelData(namespace:String) -> ChannelData

Returns a ChannelData object for the given namespace. Namespaces can be used to organize your channel’s data.


Returns ChannelData

channelData.get(key:String) -> JSON?


Returns JSON unless the key doesn’t exist. Returns null if the key doesn’t exist.


JsonObject msg = new JsonObject();
msg.putString("message", "hello channeldata!");
channelData.put("myKey", msg);

channelData.put(String key, JsonElement value)

Set the value for key.



channelData.onAdd({ (key,val) in
    println("added " + key + " => " + val)

channelData.onAdd( callback:AddCallback ) -> Void

Fires when a new key and value is added.

channelData.onUpdate({ (key,val) in
    println("updated " + key + " => " + val)

channelData.onUpdate( callback:UpdateCallback ) -> Void

Fires when a key’s value is updated.

channelData.onRemove({ (key) in
    println("removed " + key)

channelData.onRemove( callback:RemoveCallback) -> Void

Fired when a key (and it’s value) is removed.

channelData.on("myKey", callback: { (json, op) -> Void in
    println("key operation is " +  op )

channelData.on( key:String, callback:OperationCallback) -> Void

Fired when anything happens to key. value will be the new value, except in the case of a remove operation returning null instead. This event is an easy way to monitor a single key.



channelData.remove(key:String) -> Void

Remove the value associated with key.