Class XmppClient

constructor

• new XmppClient(chatUri, token, jid): XmppClient

• Parameters

  • chatUri: string
  • token: string
  • jid: string

  Returns XmppClient

emitter

addBookmark

• addBookmark(bookmark): Promise<void>

• Parameters

  • bookmark: MUCBookmark

  Returns Promise<void>

bindEventListeners

• bindEventListeners(): void

• Returns void

configureRoom

• configureRoom(room, form): Promise<IQ & {
      muc: MUCConfigure;
  }>

• Parameters

  • room: string
  • form: Partial<DataForm>

  Returns Promise<IQ & {
      muc: MUCConfigure;
  }>

deleteAccount

• deleteAccount(jid): Promise<void>

• Parameters

  • jid: string

  Returns Promise<void>

destroyRoom

• destroyRoom(room, options): Promise<IQ & {
      muc: MUCConfigure;
  }>

• Parameters

  • room: string
  • options: MUCDestroy

  Returns Promise<IQ & {
      muc: MUCConfigure;
  }>

disableNotifications

• disableNotifications(jid, node): Promise<IQ>

• Parameters

  • jid: string
  • node: string

  Returns Promise<IQ>

disconnectClient

• disconnectClient(): Promise<void>

• Returns Promise<void>

enableNotifications

• enableNotifications(jid, node, fieldList): Promise<IQ>

• Parameters

  • jid: string
  • node: string
  • fieldList: DataFormField[]

  Returns Promise<IQ>

getBookmarks

• getBookmarks(): Promise<MUCBookmark[]>

• Returns Promise<MUCBookmark[]>

getDiscoInfo

• getDiscoInfo(jid): Promise<DiscoInfoResult>

• Parameters

  • jid: string

  Returns Promise<DiscoInfoResult>

getRoomConfig

• getRoomConfig(jid): Promise<DataForm>

• Parameters

  • jid: string

  Returns Promise<DataForm>

getRoomMembers

• getRoomMembers(jid, affiliation): Promise<IQ & {
      muc: MUCUserList;
  }>

• Parameters

  • jid: string
  • affiliation: MUCAffiliation

  Returns Promise<IQ & {
      muc: MUCUserList;
  }>

invite

• invite(room, options): void

• Parameters

  • room: string
  • options: MUCInvite | MUCInvite[]

  Returns void

joinRoom

• joinRoom(jid, nick, options?): Promise<void>

• Parameters

  • jid: string
  • nick: string
  • options: Presence = {}

  Returns Promise<void>

markDisplayed

• markDisplayed(to, id, type): void

• Parameters

  • to: string
  • id: string
  • type: MessageType

  Returns void

markReceived

• markReceived(to, id, type): void

• Parameters

  • to: string
  • id: string
  • type: MessageType

  Returns void

onDisconnected

• onDisconnected(): void

• Returns void

removeBookmark

• removeBookmark(jid): Promise<void>

• Parameters

  • jid: string

  Returns Promise<void>

requestFileUploadSlot

• requestFileUploadSlot(jid, name, size, mediaType?): Promise<RequestFileUploadSlotResponse>

• Parameters

  • jid: string
  • name: string
  • size: number
  • Optional mediaType: string

  Returns Promise<RequestFileUploadSlotResponse>

searchHistory

• searchHistory(query): Promise<MAMFin>

• Parameters

  • query: MAMQueryOptions

  Returns Promise<MAMFin>

sendMessage

• sendMessage(message): Promise<void>

• Parameters

  • message: Message

  Returns Promise<void>

setRoomAffiliation

• setRoomAffiliation(room, jid, affiliation, reason?): Promise<IQ & {
      muc: MUCUserList;
  }>

• Parameters

  • room: string
  • jid: string
  • affiliation: MUCAffiliation
  • Optional reason: string

  Returns Promise<IQ & {
      muc: MUCUserList;
  }>

setSubject

• setSubject(room, subject): void

• Parameters

  • room: string
  • subject: string

  Returns void

start

• start(): Promise<void>

• Returns Promise<void>

stop

• stop(): Promise<void>

• Returns Promise<void>

unbindEventListeners

• unbindEventListeners(): void

• Returns void