com.ciscowebex.androidsdk

Class Webex

java.lang.Object

com.ciscowebex.androidsdk.Webex

public class Webex
extends java.lang.Object

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

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Webex.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
Webex(android.app.Application application, Authenticator authenticator) Constructs a new Webex 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 spaces.
MessageClient	messages() Messages are how we communicate in a space.
PersonClient	people() People are registered users of Cisco Webex.
Phone	phone() Phone can be used to make audio and video calls on Cisco Webex.
void	runInBackground(boolean background) Invoke this method when the application switches between background and foreground.
void	setLogLevel(Webex.LogLevel logLevel) Set the log level of the logging.
SpaceClient	spaces() Spaces are virtual meeting places in Cisco Webex where people post messages and collaborate to get work done.
TeamMembershipClient	teamMembershipClient() Team Memberships represent a person's relationships to teams.
TeamClient	teams() Teams are groups of people with a set of spaces 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 Webex, e.g.

Methods inherited from class java.lang.Object

equals, 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

Webex

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

Constructs a new Webex 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 Webex 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 Webex.

Returns:

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

Since:

0.1

messages

public MessageClient messages()

Messages are how we communicate in a space.

Returns:

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

Since:

0.1

See Also:

SpaceClient, MembershipClient

people

public PersonClient people()

People are registered users of Cisco Webex.

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 spaces.

Returns:

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

Since:

0.1

See Also:

SpaceClient, MessageClient

teams

public TeamClient teams()

Teams are groups of people with a set of spaces 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, SpaceClient

webhooks

public WebhookClient webhooks()

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

Returns:

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

Since:

0.1

spaces

public SpaceClient spaces()

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

Returns:

The SpaceClient is used to manage the spaces on behalf of the authenticated user.

Since:

0.1

See Also:

MembershipClient, MessageClient

setLogLevel

public void setLogLevel(Webex.LogLevel logLevel)

Set the log level of the logging.

Parameters:

logLevel - log message level