PersonClient

interface PersonClient

A client wrapper of the Cisco Webex People API

Since

0.1

Functions

Link copied to clipboard
abstract fun create(    email: String,     displayName: String?,     firstName: String?,     lastName: String?,     avatar: String?,     orgId: String?,     roles: List<PersonRole> = emptyList(),     licenses: List<String> = emptyList(),     siteUrls: List<String> = emptyList(),     handler: CompletionHandler<Person>)

Create people in the authenticated user's organization. Only admins are able to use this function

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

Delete the details of person by person id. Only admins are able to use this function

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

Retrieves the details for the given personId

Link copied to clipboard
abstract fun getMe(handler: CompletionHandler<Person>)

Retrieves the details for the logged in user

Link copied to clipboard
abstract fun getProductCapability(): ProductCapability

To get the supported capabilities of the current user.

Link copied to clipboard
abstract fun list(    email: String?,     displayName: String?,     max: Int,     handler: CompletionHandler<List<Person>>)
abstract fun list(    email: String?,     displayName: String?,     id: String?,     orgId: String? = null,     max: Int,     handler: CompletionHandler<List<Person>>)

Lists people in the authenticated user's organization.

Link copied to clipboard
abstract fun startWatchingPresences(contactIds: List<String>, handler: CompletionHandler<Presence>): List<PresenceHandle>

Start watching presence status update of the list of contact ids that are provided as input. Only valid contact Ids will be watched. Check PresenceHandle.isValid flag to know which contact Ids are valid. Same contact id can be watched multiple times and it will return different PresenceHandle objects. The application has to ensure to call the stopWatchingPresences API for the handles when not needed.

Link copied to clipboard
abstract fun stopWatchingPresences(presenceHandles: List<PresenceHandle>)

Stop watching presence status of the list of contact ids that are provided as input.

Link copied to clipboard
abstract fun update(    personId: String,     email: String?,     displayName: String?,     firstName: String?,     lastName: String?,     avatar: String?,     orgId: String?,     roles: List<PersonRole> = emptyList(),     licenses: List<String> = emptyList(),     siteUrls: List<String> = emptyList(),     handler: CompletionHandler<Person>)

Update people in the authenticated user's organization. Only admins are able to use this function