Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

getPinMessageInfoList

  • description

    Get list of pin message info

    async
    since

    2.14.0

    example
    getPinMessageInfoList({
    roomId: "37e1720a-fc7b-4962-b216-6be9ed69dc96",
    orderBy: "desc"
    }).then(pinMessageInfoList => console.log(pinMessageInfoList))

    Parameters

    Returns Promise<IPaginatedResponse<IPinMessageInfo>>

pinMessage

  • description

    Pin a chat message

    async
    since

    2.14.0

    example
    pinMessage({
    roomId: "9e6f1bc4-9f02-4c57-92b7-7521d0f5b027",
    messageId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    messagePayload: { // messagePayload of type IMessagePayload
    message: "test Message"
    }
    }).then(pinMessageInfo => console.log(pinMessageInfo))

    Parameters

    Returns Promise<IPinMessageInfo>

unpinMessage

  • description

    Unpin a chat message

    async
    since

    2.14.0

    example
    unpinMessage({
    pinMessageInfoId: "3f81ccb0-ec95-4e71-a0b7-462889699f75"
    }).then(res => console.log(res))

    Parameters

    Returns Promise<null>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc