Options
All
  • Public
  • Public/Protected
  • All
Menu

调用方式:

chatroom.chatroomQueue.update(options)

Hierarchy

  • ChatroomQueueInterface

Index

Methods

  • 批量更新至多 100 个聊天室队列的元素

    example
    chatroom.chatroomQueue.batchUpdate({
    // 批量更新元素的key-value对,key/value分别是elementKey和elementValue(elementKey 限制 128, elementValue 限制 4096 字节),一次最多更新100个
    itemList: {
    'uniKey1': 'uniValue1',
    'uniKey2': 'uniValue2'
    },
    // 可选参数,不传默认false,当设置为 true 时,所有聊天室成员会收到类型为'updateQueue'的聊天室通知消息。
    needNotify: false,
    // 通知中的自定义字段,长度限制2048
    notifyExtension: ''
    })

    Parameters

    Returns Promise<ChatroomQueue[]>

  • clear(): Promise<void>
  • 清空队列

    Returns Promise<void>

  • 排序列出所有元素

    example
    const elements = await chatroom.chatroomQueue.fetch()
    

    Returns Promise<ChatroomQueue[]>

  • 初始化聊天室队列

    聊天室队列指聊天室(房间)中由多个元素(key-value 键值对)构成的队列,应用于直播间中的连麦场景和礼物队列展示等场景。

    example
    chatroom.chatroomQueue.init({
    maxItemCount: 100
    })

    Parameters

    Returns Promise<void>

  • 查看聊天室队列中的第一个元素

    Returns Promise<ChatroomQueue>

  • 将指定元素(不传入参默认取出第一个元素)从聊天室队列中踢除

    example
    chatroom.chatroomQueue.poll({
    key: 'uniKey'
    })

    Parameters

    Returns Promise<ChatroomQueue>

  • 加入或者更新队列元素

    example
    chatroom.chatroomQueue.update({
    elementKey: 'uniKey',
    // 元素内容,长度限制4096字节
    elementValue: 'uniValue',
    // 可选参数,不传默认false,当提交这个新元素的用户从聊天室掉线或退出的时候,是否需要删除这个元素。
    transient: false,
    // 可选参数,队列元素所属账号,默认不传表示队列元素属于当前操作人,管理员可以指定队列元素归属于其他合法账号
    account: 'account'
    })

    Parameters

    Returns Promise<void>