Class XmppMucManager

constructor

• new XmppMucManager(ctx: XmppMucContext): XmppMucManager

  Parameters

  • ctx: XmppMucContext

  Returns XmppMucManager

ReadonlymucHistory

ReadonlymucRooms

close

• close(): void

  Returns void

ensureMucRoomSettings

• ensureMucRoomSettings(roomName: string): Promise<MucRoomSettings | undefined>

  Parameters

  • roomName: string

  Returns Promise<MucRoomSettings | undefined>

getMucHistory

• getMucHistory(room: string): XmppMucMessage[]

  Parameters

  • room: string

  Returns XmppMucMessage[]

getMucRoomSettings

• getMucRoomSettings(roomName: string): MucRoomSettings | undefined

  Parameters

  • roomName: string

  Returns MucRoomSettings | undefined

getRooms

• getRooms(): string[]

  Returns string[]

getRoomSettings

• getRoomSettings(roomName: string): MucRoomSettings | undefined

  Parameters

  • roomName: string

  Returns MucRoomSettings | undefined

getRoomState

• getRoomState(roomName: string): MucRoomState | undefined

  Parameters

  • roomName: string

  Returns MucRoomState | undefined

getRoomTopic

• getRoomTopic(roomName: string): string

  Parameters

  • roomName: string

  Returns string

handleIncomingMamQuery

• handleIncomingMamQuery(element: Element, peerId: string): Promise<void>

  Parameters

  • element: Element
  • peerId: string

  Returns Promise<void>

handleIncomingMamResult

• handleIncomingMamResult(element: Element, peerId: string): Promise<void>

  Parameters

  • element: Element
  • peerId: string

  Returns Promise<void>

handleIncomingPayload

• handleIncomingPayload(
      topic: string,
      fromPeerId: string,
      xmlStr: string,
  ): Promise<void>

  Parameters

  • topic: string
  • fromPeerId: string
  • xmlStr: string

  Returns Promise<void>

initialize

• initialize(): Promise<void>

  Returns Promise<void>

joinRoom

• joinRoom(roomName: string, nick: string): Promise<void>

  Parameters

  • roomName: string
  • nick: string

  Returns Promise<void>

leaveRoom

• leaveRoom(roomName: string): Promise<void>

  Parameters

  • roomName: string

  Returns Promise<void>

loadMucState

• loadMucState(): Promise<void>

  Returns Promise<void>

persistMucState

• persistMucState(): Promise<void>

  Returns Promise<void>

queryHistory

• queryHistory(
      roomName: string,
      targetPeerJid: string,
      queryId?: string,
  ): Promise<void>

  Parameters

  • roomName: string
  • targetPeerJid: string
  • OptionalqueryId: string

  Returns Promise<void>

recordMucMessage

• recordMucMessage(msg: XmppMucMessage): Promise<boolean>

  Parameters

  • msg: XmppMucMessage

  Returns Promise<boolean>

scheduleMucHistoryPersist

• scheduleMucHistoryPersist(): Promise<void>

  Returns Promise<void>

scheduleMucPersist

• scheduleMucPersist(): Promise<void>

  Returns Promise<void>

sendGroupChatMarker

• sendGroupChatMarker(
      roomName: string,
      type: "received" | "displayed",
      id: string,
  ): Promise<void>

  Parameters

  • roomName: string
  • type: "received" | "displayed"
  • id: string

  Returns Promise<void>

sendGroupChatState

• sendGroupChatState(
      roomName: string,
      state: "paused" | "active" | "composing" | "inactive" | "gone",
  ): Promise<void>

  Parameters

  • roomName: string
  • state: "paused" | "active" | "composing" | "inactive" | "gone"

  Returns Promise<void>

sendGroupMessage

• sendGroupMessage(
      roomName: string,
      body: string,
      replaceId?: string,
      messageId?: string,
      reply?: { id: string; to?: string },
      thread?: string,
  ): Promise<string>

  Parameters

  • roomName: string
  • body: string
  • OptionalreplaceId: string
  • OptionalmessageId: string
  • Optionalreply: { id: string; to?: string }
  • Optionalthread: string

  Returns Promise<string>

sendGroupMessageSecure

• sendGroupMessageSecure(
      roomName: string,
      body: string,
      replaceId?: string,
      messageId?: string,
      reply?: { id: string; to?: string },
      thread?: string,
  ): Promise<string>

  Parameters

  • roomName: string
  • body: string
  • OptionalreplaceId: string
  • OptionalmessageId: string
  • Optionalreply: { id: string; to?: string }
  • Optionalthread: string

  Returns Promise<string>

setMucRoomSettings

• setMucRoomSettings(roomName: string, settings: MucRoomSettings): void

  Parameters

  • roomName: string
  • settings: MucRoomSettings

  Returns void

setRoomSettings

• setRoomSettings(roomName: string, settings: MucRoomSettings): void

  Parameters

  • roomName: string
  • settings: MucRoomSettings

  Returns void

updateMucRoomSettings

• updateMucRoomSettings(
      roomName: string,
      settings: {
          archived?: boolean;
          autoJoin?: boolean;
          communityId?: string;
          defaultMode?: "open" | "secure";
          topic?: string;
      },
  ): Promise<void>

  Parameters

  • roomName: string
  • settings: {
        archived?: boolean;
        autoJoin?: boolean;
        communityId?: string;
        defaultMode?: "open" | "secure";
        topic?: string;
    }

  Returns Promise<void>