io.supportkit.core

Class SupportKit

java.lang.Object

io.supportkit.core.SupportKit

public final class SupportKit
extends java.lang.Object

SupportKit Entry Point

Method Summary

Methods

Modifier and Type	Method and Description
static void	destroy() Terminate the SupportKit facilities.
static Conversation	getConversation() Accessor method for the current conversation.
static java.lang.String	getGoogleCloudMessagingProjectId() Accessor method to get the Google Cloud Messaging project id that was linked to the application via the Web portal.
static InitializationStatus	getInitializationStatus() Accessor method for the current AppBoot status.
static Settings	getSettings() Accessor method for the SDK settings.
static void	init(android.app.Application application, Settings settings) Initialize the SupportKit SDK with the provided settings.
static void	init(android.app.Application application, java.lang.String appToken) Convenient method to initialize the SupportKit SDK using the default settings.
static void	login(java.lang.String userId, java.lang.String jwt) Logs in a new SupportKit user.
static void	logout() Logs out the current user.
static void	setGoogleCloudMessagingToken(java.lang.String token) Method used to register the Google Cloud Messaging token to SupportKit
static void	track(java.lang.String eventName) Tracks an app event, and processes any whispers associated with that event.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(android.app.Application application,
        java.lang.String appToken)

Convenient method to initialize the SupportKit SDK using the default settings.

See SupportKit.init(Context, Settings)

Parameters:

application - The Application

appToken - The app token

init

public static void init(android.app.Application application,
        Settings settings)

Initialize the SupportKit SDK with the provided settings.

This may only be called once (preferably, in Application.onCreate()).

Use SupportKit.getSettings() to retrieve and modify the given settings object.

Parameters:

application - The Application

settings - The settings to use

login

public static void login(java.lang.String userId,
         java.lang.String jwt)

Logs in a new SupportKit user.

You can either use this method to transition from logged out state to logged in, or to switch the currently logged in user to a different one. init: must have been called prior to calling login.

Parameters:

userId - The distinct id of the user to login. Must not be null.

jwt - Optional jwt used to prove the origin of the login request. May be null.

logout

public static void logout()

Logs out the current user.

This method will automatically login an anonymous user after logging out the current user. Calling this method while already in anonymous state has no effect.

destroy

public static void destroy()

Terminate the SupportKit facilities.

SupportKit is automatically terminated when the application exits. This method does not, usually, have to be called manually.

getSettings

public static Settings getSettings()

Accessor method for the SDK settings.

Use this object to update settings at run time. Note: Some settings may only be configured at init time. See the Settings class reference for more information.

Returns:

Settings object passed in init(Application, Settings), or null if SupportKit hasn't been initialized yet.

getConversation

public static Conversation getConversation()

Accessor method for the current conversation.

Returns:

Current conversation, or null if SupportKit.init() hasn't been called yet.

getInitializationStatus

public static InitializationStatus getInitializationStatus()

Accessor method for the current AppBoot status.

Returns:

AppBoot status, or null if SupportKit.init() hasn't been called yet.

getGoogleCloudMessagingProjectId

public static java.lang.String getGoogleCloudMessagingProjectId()

Accessor method to get the Google Cloud Messaging project id that was linked to the application via the Web portal.

Returns:

The Google Cloud Messaging project Id

setGoogleCloudMessagingToken

public static void setGoogleCloudMessagingToken(java.lang.String token)

Method used to register the Google Cloud Messaging token to SupportKit

Parameters:

token - The Google Cloud Messaging token

track

public static void track(java.lang.String eventName)

Tracks an app event, and processes any whispers associated with that event.

Whispers can be configured in the SupportKit admin panel. Whispers can only be fulfilled once per app user, and tracking an event after the whisper has been fulfilled will have no effect.

Parameters:

eventName - The name of the event to track. This should match a whisper created on the admin panel for your app.