com.ciscospark.androidsdk

Class Spark

java.lang.Object

com.ciscospark.androidsdk.Spark

public class Spark
extends java.lang.Object

Spark object is the entry point to use this Cisco Spark Android SDK.

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Spark.LogLevel The enumeration of log message level

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_NAME
static java.lang.String	APP_VERSION

Constructor Summary

Constructors

Constructor and Description
Spark(android.app.Application application, Authenticator authenticator) Constructs a new Spark object with an Authenticator and Application

Method Summary

Modifier and Type	Method and Description
Authenticator	getAuthenticator()
java.lang.String	getVersion() Get current SDK version
MembershipClient	memberships() Memberships represent a person's relationships to rooms.
MessageClient	messages() Messages are how we communicate in a room.
PersonClient	people() People are registered users of Cisco Spark.
Phone	phone() Phone can be used to make audio and video calls on Cisco Spark.
RoomClient	rooms() Rooms are virtual meeting places in Cisco Spark where people post messages and collaborate to get work done.
void	runInBackground(boolean background) Invoke this method when the application switches between background and foreground.
void	setLogLevel(Spark.LogLevel logLevel) Set the log level of the logging.
TeamMembershipClient	teamMembershipClient() Team Memberships represent a person's relationships to teams.
TeamClient	teams() Teams are groups of people with a set of rooms that are visible to all members of that team.
WebhookClient	webhooks() Webhooks allow the application to be notified via HTTP (or HTTPS?) when a specific event occurs in Cisco Spark, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

APP_NAME

public static final java.lang.String APP_NAME

See Also:

Constant Field Values

APP_VERSION

public static final java.lang.String APP_VERSION

Constructor Detail

Spark

public Spark(android.app.Application application,
             Authenticator authenticator)

Constructs a new Spark object with an Authenticator and Application

Parameters:

application - The android application

authenticator - The authentication strategy for this SDK

Since:

0.1

Method Detail

getVersion

public java.lang.String getVersion()

Get current SDK version

Returns:

major.minor.build-alpha/beta/SNAPSHOT

Since:

0.1

runInBackground

public void runInBackground(boolean background)

Invoke this method when the application switches between background and foreground.

Parameters:

background - application run in background or not.

Since:

0.1

getAuthenticator

public Authenticator getAuthenticator()

Returns:

The Authenticator object from the application when constructing this Spark object. It can be used to check and modify authentication state.

Since:

0.1

phone

public Phone phone()

Phone can be used to make audio and video calls on Cisco Spark.

Returns:

The Phone represents a calling device in Cisco Spark Android SDK.

Since:

0.1

messages

public MessageClient messages()

Messages are how we communicate in a room.

Returns:

The MessageClient is uesd to manage the messages on behalf of the authenticated user.

Since:

0.1

See Also:

RoomClient, MembershipClient

people

public PersonClient people()

People are registered users of Cisco Spark.

Returns:

The PersonClient is used to find a person on behalf of the authenticated user.

Since:

0.1

See Also:

MembershipClient, MessageClient

memberships

public MembershipClient memberships()

Memberships represent a person's relationships to rooms.

Returns:

The MembershipClient is used to manage the authenticated user's relationship to rooms.

Since:

0.1

See Also:

RoomClient, MessageClient

teams

public TeamClient teams()

Teams are groups of people with a set of rooms that are visible to all members of that team.

Returns:

The TeamClient is used to create and manage the teams on behalf of the authenticated user.

Since:

0.1

See Also:

TeamMembershipClient, MembershipClient

teamMembershipClient

public TeamMembershipClient teamMembershipClient()

Team Memberships represent a person's relationships to teams.

Returns:

The TeamMembershipClient is used to create and manage the team membership on behalf of the authenticated user.

Since:

0.1

See Also:

TeamClient, RoomClient

webhooks

public WebhookClient webhooks()

Webhooks allow the application to be notified via HTTP (or HTTPS?) when a specific event occurs in Cisco Spark, e.g. a new message is posted into a specific room.

Returns:

The WebhookClient is used to create and manage the webhooks for specific events.

Since:

0.1

rooms

public RoomClient rooms()

Rooms are virtual meeting places in Cisco Spark where people post messages and collaborate to get work done.

Returns:

The RoomClient is used to manage the rooms on behalf of the authenticated user.

Since:

0.1

See Also:

MembershipClient, MessageClient

setLogLevel

public void setLogLevel(Spark.LogLevel logLevel)

Set the log level of the logging.

Parameters:

logLevel - log message level