SpaceClient

interface SpaceClient

A client wrapper of Space APIs that allows various operations such list, create, delete etc

Since

0.1

Types

Link copied to clipboard
enum SortBy : Enum<SpaceClient.SortBy>

An enumeration for sorting a space based on the several properties

Functions

Link copied to clipboard
abstract fun create(    title: String,     teamId: String?,     handler: CompletionHandler<Space>)

Creates a space. The authenticated user is automatically added as a member of the space. See the Memberships API to learn how to add more people to the space.

Link copied to clipboard
abstract fun delete(spaceId: String, handler: CompletionHandler<DeleteSpaceResult>)

Deletes a space by id.

Link copied to clipboard
abstract fun filter(query: String, handler: CompletionHandler<List<Space>>)

Fetches a filtered list of spaces that you are already a part of.

Link copied to clipboard
abstract fun get(spaceId: String, handler: CompletionHandler<Space>)

Retrieves the details for a space by id.

Link copied to clipboard
abstract fun getMeetingInfo(spaceId: String, handler: CompletionHandler<SpaceMeetingInfo>)

Shows Webex meeting details for a space such as the SIP address, meeting URL, toll-free and toll dial-in numbers.

Link copied to clipboard
abstract fun getWithReadStatus(spaceId: String, handler: CompletionHandler<SpaceReadStatus>)

Returns a SpaceReadStatus with the details about the date of the last activity in the space, and the date of current user last presence in the space. For spaces where lastActivityDate lastSeenDate the space can be considered to be "unread"

Link copied to clipboard
abstract fun isSpacesSyncCompleted(): Boolean

Denotes if syncing latest spaces to local database is complete. The SpaceClient.list API will return correct number of spaces, only when this API returns true

Link copied to clipboard
abstract fun list(    teamId: String?,     max: Int?,     type: Space.SpaceType?,     sortBy: SpaceClient.SortBy?,     handler: CompletionHandler<List<Space>>)

Lists all spaces where the authenticated user belongs.

Link copied to clipboard
abstract fun listWithActiveCalls(handler: CompletionHandler<List<String>>)

Returns a list of spaces in which there are active calls.

Link copied to clipboard
abstract fun listWithReadStatus(max: Int, handler: CompletionHandler<List<SpaceReadStatus>>)

Returns a list of SpaceReadStatus with details about the date of the last activity in the space, and the date of current user last presence in the space. The list is sorted with this with most recent activity first. For spaces where lastActivityDate lastSeenDate the space can be considered to be "unread"

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

Denotes if syncing latest conversations to local database is complete

Link copied to clipboard
abstract fun setOnSpaceSyncingStatusChangedListener(handler: CompletionHandler<Boolean>)

Sets a listener that is called whenever the status for syncing of spaces changes.

Link copied to clipboard
abstract fun setSpaceObserver(observer: SpaceObserver?)

Sets a SpaceObserver in this client.

Link copied to clipboard
abstract fun update(    spaceId: String,     newName: String,     handler: CompletionHandler<Space>)

Updates the details for a space by id.