Class PChatSDK

messages

state

user

Errors

• get Errors(): typeof Errors

• Returns typeof Errors

Events

• get Events(): typeof Events

• Returns typeof Events

States

• get States(): typeof States

• Returns typeof States

clearRoom

• clearRoom(): Promise<{
      matched: number;
      modified: number;
  }>

• Clears the current room messages (soft delete all). Moderator only.

  Returns Promise<{
      matched: number;
      modified: number;
  }>

connect

• connect(room, username, token, options?): Promise<void>

• Used for connecting to chat room server. On success will initialize PChatSDK.user and set PChatSDK.state to States.CONNECTED. Triggers Events.CONNECT on success.

  Parameters

  • room: string

    Room id
  • username: string

    Username
  • token: string

    JWT access token from CAS
  • Optional options: {
        role?: string;
        scheme: "https" | "http";
    }

    Optional connection settings

    • Optional role?: string

      Optional role to claim for this user

    • scheme: "https" | "http"

  Returns Promise<void>

  Throws

  PChatError

createPoll

• createPoll(question, options, scheduledDate?): Promise<PollType>

• Used for creating a poll. Triggers Events.POLL on success.

  Parameters

  • question: string

    The question of the poll
  • options: string[]

    The options of the poll
  • Optional scheduledDate: Date

    The date when the poll should be published

  Returns Promise<PollType>

  Throws

  PChatError

deleteMessage

• deleteMessage(messageId): Promise<MessageType>

• Used for soft deleting a message. Triggers Events.MESSAGE_DELETE on success.

  Parameters

  • messageId: string

    Message identifier to delete

  Returns Promise<MessageType>

  Throws

  PChatError

disconnect

• disconnect(): void

• Disconnects from chat server and sets PChatSDK.state to States.DISCONNECTED. Triggers Events.DISCONNECT.

  Returns void

finishPoll

• finishPoll(pollId): Promise<PollType>

• Used for finishing a poll. Triggers Events.POLL on success.

  Parameters

  • pollId: string

  Returns Promise<PollType>

  Throws

  PChatError

getPoll

• getPoll(): Promise<PollType[]>

• Used for getting active poll

  Returns Promise<PollType[]>

  PollType[]

  Throws

  PChatError

getReactionStats

• getReactionStats(): Promise<ReactionStatsType[]>

• Used for getting reaction stats. Triggers Events.REACTIONS_STATS on success.

  Returns Promise<ReactionStatsType[]>

  Throws

  PChatError

loadOlder

• loadOlder(timestamp?): Promise<PChatSDK>

• Used for loading older chat room's history. Consecutive calls will be handled in a queue. Triggers Events.HISTORY_LOAD on success.

  Parameters

  • Optional timestamp: string

    Timestamp to load messages before, by default oldest message's timestamp is used

  Returns Promise<PChatSDK>

  Throws

  PChatError

publish

• publish(content): Promise<MessageType>

• Used for sending a message to the chat room. Triggers Events.MESSAGE on success.

  Parameters

  • content: string

    Message content

  Returns Promise<MessageType>

  Throws

  PChatError

sendReaction

• sendReaction(reaction): Promise<ReactionType>

• Used for sending a reaction to the chat room. Triggers Events.REACTION on success.

  Parameters

  • reaction: string

  Returns Promise<ReactionType>

  Throws

  PChatError

votePoll

• votePoll(pollId, optionId): Promise<OptionType>

• Used for voting on a poll

  Parameters

  • pollId: string
  • optionId: string

  Returns Promise<OptionType>

  Throws

  PChatError