Events

VoxImplant.IMEvents.ChatHistoryReceived

Event dispatched when chat history received

Properties
  • id: String

    User id

  • message_id: String

    Message id specified for getInstantMessagingHistory method

  • messages: Array

    List of messages. See VoxImplant.IMHistoryMessage

VoxImplant.IMEvents.ChatRoomBanList

Event dispatched when info about banned chat room participants received

Properties

VoxImplant.IMEvents.ChatRoomCreated

Event dispatched if chat room was created successfully

Properties
  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomError

Event dispatched in case of error while chat room operation

Properties
  • code: String

    Error code

  • operation: String

    Operation name

  • room: String

    Room id

  • text: String

    Error description

VoxImplant.IMEvents.ChatRoomHistoryReceived

Event dispatched when chat room history received

Properties
  • message_id: String

    Message id specified for getChatRoomHistory method

  • messages: Array

    List of messages. See VoxImplant.IMHistoryMessage

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomInfo

Event dispatched when user joins chat room

Properties

VoxImplant.IMEvents.ChatRoomInvitation

Event dispatched when invitation to chat room received

Properties
  • body: String

    The body of the message

  • from: String

    User id (inviter)

  • password: String

    Password for the room

  • reason: String

    A reason of the invitation

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomInviteDeclined

Event dispatched if an invitation to chat room was declined by the invitee

Properties
  • invitee: String

    User id (invitee)

  • reason: String

    A reason of the invitation

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomMessageModified

Event dispatched when chat room message modified

Properties
  • content: String

    New message content

  • from: String

    User id

  • message_id: String

    Modified message id

  • private_message: Boolean

    Private/public message flag

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • room: String

    Room id

  • timestamp: Number

    Message timestamp

VoxImplant.IMEvents.ChatRoomMessageNotModified

Event dispatched in case of error during chat room message modification

Properties
  • code: Number

    Error code

  • message_id: String

    Modified message id

  • private_message: Boolean

    Private/public message flag

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomMessageReceived

Event dispatched when instant message was sent to chat room

Properties
  • content: String

    Message content

  • from: String

    User id

  • message_id: String

    Message id

  • private_message: Boolean

    Private/public message

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • room: String

    Room id

  • timestamp: Number

    Message timestamp

VoxImplant.IMEvents.ChatRoomMessageRemoved

Event dispatched when chat room message removed room, private_message, message_id, timestamp, from

Properties
  • from: String

    User id

  • message_id: String

    Deleted message id

  • private_message: Boolean

    Private/public message flag

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • room: String

    Room id

  • timestamp: Number

    Message timestamp

VoxImplant.IMEvents.ChatRoomNewParticipant

Event dispatched when new participant joined the chat room

Properties
  • displayName: String

    User display name

  • participant: String

    User id

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomOperation

Event dispatched as a result of ban/unban

Properties

VoxImplant.IMEvents.ChatRoomParticipantExit

Event dispatched when participant left the chat room

Properties
  • participant: String

    User id

  • room: String

    Room id

VoxImplant.IMEvents.ChatRoomParticipants

Event dispatched when info about chat room participants received

Properties

VoxImplant.IMEvents.ChatRoomPresenceUpdate

Event dispatched if chat room participant presence status was updated

Properties

VoxImplant.IMEvents.ChatRoomStateUpdate

Event dispatched when chat session state updated

Properties

VoxImplant.IMEvents.ChatRoomSubjectChange

Event dispatched if chat room subject was changed

Properties
  • id: String

    User who changed the subject

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • room: String

    Room id

  • subject: String

    New subject

VoxImplant.IMEvents.ChatRoomsDataReceived

Event dispatched when information about chat rooms where user participates received

Properties

VoxImplant.IMEvents.ChatStateUpdate

Event dispatched when chat session state updated

Properties
  • id: String

    User id

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • state: Number

    Current chat session state. See VoxImplant.ChatStateType enum

VoxImplant.IMEvents.MessageModified

Event dispatched when instant message was modified by user

Properties
  • content: String

    Message content

  • id: String

    User id (of the user who sent the message)

  • message_id: String

    Message id

  • to: String

    User id (of the user to whom the message was sent)

VoxImplant.IMEvents.MessageNotModified

Event dispatched if error happened during instant message modification

Properties
  • code: Number

    Error code

  • message_id: String

    Message id

  • to: String

    User id (of the user to whom the message was sent)

VoxImplant.IMEvents.MessageReceived

Event dispatched when instant message received

Properties
  • content: String

    Message content

  • id: String

    User id (of the user who sent the message)

  • message_id: String

    Message id

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • to: String

    User id (of the user to whom the message was sent)

VoxImplant.IMEvents.MessageRemoved

Event dispatched when instant message was removed by user

Properties
  • id: String

    User id (of the user who sent the message)

  • message_id: String

    Message id

  • to: String

    User id (of the user to whom the message was sent)

VoxImplant.IMEvents.MessageStatus

Event dispatched when sent message status changed

Properties
  • code: Number

    Error code in case of error

  • id: String

    User id

  • message_id: String

    Message id

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • type: VoxImplant.MessageEventType

    Message event type

VoxImplant.IMEvents.PresenceUpdate

Event dispatched when self presence updated

Properties
  • id: String

    User id

  • message: String

    Status message

  • presence: Number

    Current presence status

  • resource: String

    Allows to distinguish same user who logged in from different devices

VoxImplant.IMEvents.RosterItemChange

Event dispatched when roster item changed

Properties
  • displayName: String

    User display name

  • groups: Array

    Roster item groups

  • id: String

    User id

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • type: Number

    Roster item event type. See VoxImplant.RosterItemEvent enum

VoxImplant.IMEvents.RosterPresenceUpdate

Event dispatched when roster item presence update happened

Properties
  • id: String

    User id

  • message: String

    Status message

  • presence: Number

    Current presence status

  • resource: String

    Allows to distinguish same user who logged in from different devices

VoxImplant.IMEvents.RosterReceived

Event dispatched when roster data received

Properties

VoxImplant.IMEvents.SubscriptionRequest

Event dispatched when some user tries to add current user into his roster. Current user can confirm or reject the subscription, then VoxImplant.IMEvents.RosterItemChange will be dispatched on for user that made the request

Properties
  • id: String

    User id

  • message: String

    Optional message

  • resource: String

    Allows to distinguish same user who logged in from different devices

  • type: VoxImplant.SubscriptionRequestType

    Subscription request type

VoxImplant.IMEvents.SystemError

Event dispatched in case of instant messaging subsystem error

Properties
  • errorData: Object

    Error data object, contains the error details

  • errorType: VoxImplant.IMErrorType

    Error type

VoxImplant.IMEvents.UCConnected

Event dispatched when instant messaging and presence subsystems (UC) are online

VoxImplant.IMEvents.UCDisconnected

Event dispatched when instant messaging and presence subsystems (UC) are offline. See imAutoReconnect