com.captainup.android.core

Class CaptainUpConnectionFactory

java.lang.Object

com.captainup.android.core.CaptainUpConnectionFactory

public final class CaptainUpConnectionFactory
extends java.lang.Object

The entry point to the Captain Up SDK. Use this factory to create Captain Up Connections.

Method Summary

Modifier and Type	Method and Description
static CaptainUpConnection	createConnection(java.lang.String url, java.lang.String appId, java.lang.String mobileToken) Creates a new Captain Up Connection object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createConnection

public static CaptainUpConnection createConnection(java.lang.String url,
                                                   java.lang.String appId,
                                                   java.lang.String mobileToken)

Creates a new Captain Up Connection object. You should re-use connections where available, instead of calling this method each time you want to communicate with captain up.

Parameters:

url - the URL to the captain up site. Usually would be: https://captainup.com

appId - the ID of the application to connect to. See the Captain Up Admin Panel -> Settings -> General Settings -> API Key.

mobileToken - the application's mobile token. See the Captain Up Admin Panel -> Settings -> General Settings -> Client Token.

Returns:

a new Captain Up Connection object ready to be used to communicate with the captain up platform.