Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ChatroomQueueInterface

Index

Interfaces

Type Aliases

Type Aliases

ChatroomQueue

ChatroomQueue: {}

Type declaration

  • [key: string]: string

QueueBatchUpdateOptions

QueueBatchUpdateOptions: { itemList: {}; needNotify?: boolean; notifyExtension?: string }

Type declaration

  • itemList: {}

    批量更新元素的key-value对，key/value分别是elementKey和elementValue（elementKey 限制 128, elementValue 限制 4096 字节），一次最多更新100个

    • [key: string]: string
  • Optional needNotify?: boolean

    是否需要发送广播通知，可选参数，不传默认false，当设置为 true 时，所有聊天室成员会收到类型为'updateQueue'的聊天室通知消息。

  • Optional notifyExtension?: string

    通知中的自定义字段，长度限制2048

QueueInitOptions

QueueInitOptions: { maxItemCount: number }

Type declaration

  • maxItemCount: number

    新建队列的长度限制(0~1000),可以对现有队列做此操作，修改现有队列的长度上限；当前队列如果已经超过了新的限制，元素不会减少，但是新元素无法增加

QueuePollOptions

QueuePollOptions: { key?: string }

Type declaration

  • Optional key?: string

    需要取出的元素的 UniqKey, 传空传表示取出第一个元素

QueueUpdateOptions

QueueUpdateOptions: { account?: boolean; elementKey: string; elementValue: string; transient?: boolean }

Type declaration

  • Optional account?: boolean

    可选参数，队列元素所属账号，默认不传表示队列元素属于当前操作人，管理员可以指定队列元素归属于其他合法账号

  • elementKey: string

    新元素的UniqKey，长度限制128字节

  • elementValue: string

    新元素内容，长度限制4096字节

  • Optional transient?: boolean

    可选参数，不传默认false，当提交这个新元素的用户从聊天室掉线或退出的时候，是否需要删除这个元素。