Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NIMUpdateChatroomOptions

Hierarchy

  • NIMUpdateChatroomOptions

Index

Properties

antiSpamBusinessId?: string

Business ID for moderation

chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }

Chat room fields to be updated

Type declaration

  • Optional announcement?: string

    Announcement

  • Optional broadcastUrl?: string

    Live streaming URL

  • Optional custom?: string

    Extension field

  • Optional name?: string

    Chat room name

  • Optional queuelevel?: string

    Queue management permissions: 0: everyone has the permission to change the queue, 1: only the anchor administrator can operate the change

custom?: string

extension field of notifications

needNotify: boolean

Whether a notification is required.

Methods

  • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { antiSpamBusinessId?: string; chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }; custom?: string; needNotify: boolean; done?: any }): void
  • callback for the result

    Parameters

    • err: null | NIMCommonError | Error | NIMStrAnyObj
    • data: { antiSpamBusinessId?: string; chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }; custom?: string; needNotify: boolean; done?: any }
      • Optional antiSpamBusinessId?: string

        Business ID for moderation

      • chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }

        Chat room fields to be updated

        • Optional announcement?: string

          Announcement

        • Optional broadcastUrl?: string

          Live streaming URL

        • Optional custom?: string

          Extension field

        • Optional name?: string

          Chat room name

        • Optional queuelevel?: string

          Queue management permissions: 0: everyone has the permission to change the queue, 1: only the anchor administrator can operate the change

      • Optional custom?: string

        extension field of notifications

      • needNotify: boolean

        Whether a notification is required.

      • done?:function

    Returns void