io.telepat.sdk

Class Telepat

java.lang.Object

io.telepat.sdk.Telepat

public final class Telepat
extends java.lang.Object

Created by Andrei Marinescu, catalinivan on 10/03/15. Telepat Main Orchestrator

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Close the current Telepat instance.
OctopusApi	getAPIInstance() Get access to an Retrofit instance that is able to communicate with the Telepat Sync API
java.util.Map<java.lang.Integer,TelepatContext>	getContexts() Get a Map of all curently active contexts for the Telepat Application
TelepatInternalDB	getDBInstance() Get access to an instance controlling the internal storage DB
java.lang.String	getDeviceLocalIdentifier() Get a unique device identifier.
static Telepat	getInstance()
Channel	getSubscribedChannel(java.lang.String channelIdentifier) Get the Channel instance of a locally registered channel.
void	initialize(android.content.Context context, java.lang.String telepatEndpoint, java.lang.String clientApiKey, java.lang.String clientAppId, java.lang.String senderId)
void	login(java.lang.String fbToken) Send a Telepat Sync API call for logging in a user
void	logout() Send a Telepat Sync API call for logging out the current user.
void	registerDevice(java.lang.String regId, boolean shouldUpdateBackend) Send the Telepat Sync API a device registration request
void	registerSubscription(Channel mChannel) Locally register an active subscription to a Telepat Channel with the Telepat SDK instance (new channel objects register themselves automatically)
void	removeSubscription(Channel mChannel) Remove a locally registered subscription of a Telepat Channel object (this does not send any notifications to the Telepat Sync API
void	setDeviceLocalIdentifier(java.lang.String udid) Set the unique device identifier sent to the Telepat cloud.
Channel	subscribe(TelepatContext context, java.lang.String modelName, OnChannelEventListener listener, java.lang.Class type) Create a new subscription to a Telepat channel

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Telepat getInstance()

Returns:

Returns a reference to the singleton instance

getDBInstance

public TelepatInternalDB getDBInstance()

Get access to an instance controlling the internal storage DB

Returns:

An instance of a class implementing TelepatInternalDB

getAPIInstance

public OctopusApi getAPIInstance()

Get access to an Retrofit instance that is able to communicate with the Telepat Sync API

Returns:

An OctopusApi instance

initialize

public void initialize(android.content.Context context,
              java.lang.String telepatEndpoint,
              java.lang.String clientApiKey,
              java.lang.String clientAppId,
              java.lang.String senderId)

destroy

public void destroy()

Close the current Telepat instance. You should reinitialize the Telepat SDK before doing additional work.

registerDevice

public void registerDevice(java.lang.String regId,
                  boolean shouldUpdateBackend)

Send the Telepat Sync API a device registration request

Parameters:

regId - A GCM token for the current device

shouldUpdateBackend - If true, an update should be sent to the Telepat cloud instance regardless of the state of the token (new/already sent)

login

public void login(java.lang.String fbToken)

Send a Telepat Sync API call for logging in a user

Parameters:

fbToken - A Facebook OAUTH token

logout

public void logout()

Send a Telepat Sync API call for logging out the current user.

subscribe

public Channel subscribe(TelepatContext context,
                java.lang.String modelName,
                OnChannelEventListener listener,
                java.lang.Class type)

Create a new subscription to a Telepat channel

Parameters:

context - The context ID where the desired objects live in

modelName - The model name of the desired objects

listener - An object implementing OnChannelEventListener. All channel events will be sent to this object.

type - The desired Java class of the objects that will be emitted in this channel (should extend the TelepatBaseModel class)

Returns:

a Channel object with the specified characteristics

getContexts

public java.util.Map<java.lang.Integer,TelepatContext> getContexts()

Get a Map of all curently active contexts for the Telepat Application

Returns:

A Map instance containing TelepatContext objects stored by their ID

removeSubscription

public void removeSubscription(Channel mChannel)

Remove a locally registered subscription of a Telepat Channel object (this does not send any notifications to the Telepat Sync API

Parameters:

mChannel - The channel instance

registerSubscription

public void registerSubscription(Channel mChannel)

Locally register an active subscription to a Telepat Channel with the Telepat SDK instance (new channel objects register themselves automatically)

Parameters:

mChannel - The channel object to be registered

getSubscribedChannel

public Channel getSubscribedChannel(java.lang.String channelIdentifier)

Get the Channel instance of a locally registered channel.

Parameters:

channelIdentifier - A properly formatted string of the channel identifier.

Returns:

the Channel instance

getDeviceLocalIdentifier

public java.lang.String getDeviceLocalIdentifier()

Get a unique device identifier. Used internally for detecting already registered devices

Returns:

A String containing the UDID

setDeviceLocalIdentifier

public void setDeviceLocalIdentifier(java.lang.String udid)

Set the unique device identifier sent to the Telepat cloud. This method should be used as early as possible, before registering the device with the Sync API.

Parameters:

udid - the desired UDID