API Docs for:
Show:

user_presence Class

Module: user

Provides the status of the user presence.

It can throw Exceptions.

Methods

isValidUserPresence

(
  • status
)
Boolean

Checks if the user presence status is valid.

Parameters:

  • status String

    The status of the user presence

Returns:

Boolean:

Return true if the user presence status is valid, false otherwise.

isValidUserPresenceOnBusy

(
  • status
)
Boolean

Checks if the user presence status on busy is valid.

Parameters:

  • status String

    The status of the user presence on busy

Returns:

Boolean:

Return true if the user presence status on busy is valid, false otherwise.

isValidUserPresenceOnUnavailable

(
  • status
)
Boolean

Checks if the user presence status on unavailable is valid.

Parameters:

  • status String

    The status of the user presence on unavailable

Returns:

Boolean:

Return true if the user presence status on unavailable is valid, false otherwise.

Properties

STATUS

Object

The list of the user presence.

Default: { "dnd": "dnd", "online": "online", "voicemail": "voicemail", "cellphone": "cellphone", "callforward": "callforward" }

STATUS_ONBUSY

Object

The list of the conditional user presence on busy.

Default: { "online": "online", "voicemail": "voicemail", "cellphone": "cellphone", "callforward": "callforward" }

STATUS_ONUNAVAILABLE

Object

The list of the conditional user presence on unavailable.

Default: { "online": "online", "voicemail": "voicemail", "cellphone": "cellphone", "callforward": "callforward" }