Webex

class Webex(application: <Error class: unknown class>, authenticator: Authenticator)

Webex object is the entry point to use this Cisco Webex Android SDK. Constructs a new Webex object with an Authenticator and Application

Since

0.1

Parameters

application

The android application

authenticator

The authentication strategy for this SDK

Constructors

Link copied to clipboard
fun Webex(application: <Error class: unknown class>, authenticator: Authenticator)

Types

Link copied to clipboard
enum Base64EncodeResult : Enum<Webex.Base64EncodeResult>

The enumeration of base64 encode api result

Link copied to clipboard
object Companion
Link copied to clipboard
enum LogLevel : Enum<Webex.LogLevel>

The enumeration of log message level

Functions

Link copied to clipboard
fun base64Decode(encodedResource: String): String?

Decodes the base64 encodedResource and returns the decoded string.

Link copied to clipboard
fun base64Encode(    type: ResourceType,     resource: String,     handler: CompletionHandler<String>)

Encodes the resource to base64 string

Link copied to clipboard
fun enableConsoleLogger(enable: Boolean)

Enables console logging

Link copied to clipboard
fun forceRegisterPhoneServices()

To force register the Phone Services on current android device when PhoneServiceRegistrationFailureReason is RegisteredElsewhere

Link copied to clipboard
fun getCallIdByNotificationId(notificationId: String, callType: NotificationCallType): String

Returns the actual call id of the call based on callType. For webex calls, webhooks return session Id of Locus, which should be used to get call id For cucm calls, pushrest server provides push id, which should be used to get call id

Link copied to clipboard
fun getlogFileUri(includelastRunLog: Boolean = false): <Error class: unknown class>

Returns file URI where all the logs are stored

Link copied to clipboard

Get the Calling service connection status.

Link copied to clipboard
fun getVersion(): String

Get current SDK version

Link copied to clipboard
fun initialize(handler: CompletionHandler<Void>)

Initializes the WebexSDK. This method should be called before invoking any other API

Link copied to clipboard
fun isUCLoggedIn(): Boolean

Returns true if user already logged on calling service, false otherwise

Link copied to clipboard
fun parseVoipPayload(payload: String): VoicePushInfo

Parses and returns the caller related information from the VoIP notification.

Link copied to clipboard
fun retryUCSSOLogin()

Retry the SSO Session for UC Login, call this API when onUCSSOLoginFailed is executed to retry the login

Link copied to clipboard
fun setCallServiceCredential(username: String, password: String)

Setting username and password for authentication with calling service. Typically this information is obtained from user after setCallServerDomainUrl

Link copied to clipboard
fun setCUCMCredential(username: String, password: String)

Setting username and password for authentication with calling service. Typically this information is obtained from user after setUCDomainServerUrl

Link copied to clipboard
fun setLogLevel(logLevel: Webex.LogLevel)

Set the log level of the logging.

Link copied to clipboard
fun setUCDomainServerUrl(ucDomain: String, serverUrl: String)

Sets the Calling server URL and domain for authentication with Calling service. In response to WebexUCLoginDelegate.showUCNonSSOLoginView notification, an UI to capture domain or server url needs to be shown by application. Below API is used to set user entered server url or domain towards SDK.

Link copied to clipboard
fun startUCServices()

To initiate the CUCM services, must be called before calling any other CUCM API.

Link copied to clipboard
fun ucCancelSSOLogin()

Cancels current SSO authentication

Properties

Link copied to clipboard
var authDelegate: WebexAuthDelegate?

Register for WebexAuthDelegate instance to receive all authentication related event callbacks

Link copied to clipboard
var authenticator: Authenticator?
Link copied to clipboard
var calendarMeetings: CalendarMeetingClient

CalendarMeetingClient is a client wrapper of Cisco Webex Calendar Meeting APIs.

Link copied to clipboard
var delegate: WebexUCLoginDelegate?

Register WebexDelegate instance to receive all the webex event callbacks

Link copied to clipboard
var memberships: MembershipClient

MembershipClient is a client wrapper of Cisco Webex Membership related APIs.

Link copied to clipboard
var messages: MessageClient

MessageClient is a client wrapper of Cisco Webex Messages related APIs.

Link copied to clipboard
var people: PersonClient

PersonClient is a client wrapper of Cisco Webex Person

Link copied to clipboard
var phone: Phone

Phone is a wrapper of the available calling related APIs

Link copied to clipboard
var spaces: SpaceClient

SpaceClient is a client wrapper of Cisco Webex Space related APIs such as create, update, delete etc.

Link copied to clipboard
var teamMembershipClient: TeamMembershipClient

TeamMembershipClient is a client wrapper of Cisco Webex Teams Membership related APIs.

Link copied to clipboard
var teams: TeamClient

TeamClient is a client wrapper of Cisco Webex Teams APIs.

Link copied to clipboard
var webhooks: WebhookClient

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.