NIMChatroomMemberInterface

Hierarchy

NIMChatroomMemberInterface

Implemented by

Chatroom

Index

Methods

getChatroomMemberCountByTag

getChatroomMemberCountByTag(_options: { tag: string; done: any }): void

Query the number of online users with a specified tag

Parameters
- _options: { tag: string; done: any }
  - tag: string
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { members: NIMChatroomMember[] }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { members: NIMChatroomMember[] }
        members: NIMChatroomMember[]
      Returns void
Returns void

getChatroomMembers

getChatroomMembers(_options: { guest: boolean; limit?: number; onlyOnline?: boolean; time?: number; done: any }): void

Get the list of members in a chat room.

Parameters
- _options: { guest: boolean; limit?: number; onlyOnline?: boolean; time?: number; done: any }
  - guest: boolean
    
    Whether the user is a guest
  - Optional limit?: number
    
    for pagination, default value: 100.
  - Optional onlyOnline?: boolean
    
    Whether to only query online members. This parameter is only valid when guest = false
  - Optional time?: number
    Start time for pagination; query the list of members after this time in reverse order
    
    Do not fill out for the first time, the default value 0 represents the current server time to get the first page
    
    For the second page and beyond, fill in the updateTime of the last member of the last page
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { members: NIMChatroomMember[] }): void
    - callback
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { members: NIMChatroomMember[] }
        members: NIMChatroomMember[]
      Returns void
Returns void

getChatroomMembersByTag

getChatroomMembersByTag(_options: { limit?: number; tag: string; time?: number; done: any }): void

Get the members of a chat room by tag

Parameters
- _options: { limit?: number; tag: string; time?: number; done: any }
  - Optional limit?: number
    
    for pagination, default value: 100.
  - tag: string
    
    Tag. Get the list of members with the tag.
  - Optional time?: number
    Start time for pagination; query the list of members after this time in reverse order
    
    Do not fill out for the first time, the default value 0 represents the current server time to get the first page
    
    For the second page and beyond, fill in the enterTime of the last member of the last page
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { members: NIMChatroomMember[] }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { members: NIMChatroomMember[] }
        members: NIMChatroomMember[]
      Returns void
Returns void

getChatroomMembersInfo

getChatroomMembersInfo(_options: { accounts: string[]; done: any }): void

Get the member information in a chat room. Get up to 20 accounts each time

Parameters
- _options: { accounts: string[]; done: any }
  - accounts: string[]
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { members: NIMChatroomMember[] }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { members: NIMChatroomMember[] }
        members: NIMChatroomMember[]
      Returns void
Returns void

kickChatroomMember

kickChatroomMember(_options: { account: string; custom?: string; done?: any }): void

Remove a member from the chat room.
- If a member is removed from the chat room, other members receive a notification of type attach.type === 'kickMember'.
- The removed members get notified by the ondisconnect callback, callback code = 'kicked'
Associated function
- NIMChatroomGetInstanceOptions.onmsgs
- NIMChatroomGetInstanceOptions.ondisconnect
Parameters
- _options: { account: string; custom?: string; done?: any }
  - account: string
    
    removed account
  - Optional custom?: string
    
    Custom information It is recommended to use JSON format. For data other than JSON format, the web client will receive the data but will be ignored by other clients.
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { account: string }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { account: string }
        account: string
      Returns void
Returns void

markChatroomBlacklist

markChatroomBlacklist(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void

Add a member to the blocklist
- If a member is added to the blocklist, other members in the chat room receive a notification of type attach.type === 'blackMember'.
- If a member is removed from the blocklist, other members in the chat room receive a notification of type attach.type === 'unblackMember' .
- Members in the blocklist get notified by the ondisconnect callback, callback code = 'kicked', reason = 'blacked'
- Members in the blocklist cannot join the chat room
Associated function
- NIMChatroomGetInstanceOptions.onmsgs
- NIMChatroomGetInstanceOptions.ondisconnect
Parameters
- _options: { account: string; custom?: string; isAdd: boolean; done: any }
  - account: string
    
    Account to be assigned role
  - Optional custom?: string
    
    Extension field, the value of attach.custom in the notifications.
  - isAdd: boolean
    
    true: to assign role, false: unassign role
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomMember): void
    - callback for the result
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomMember
      Returns void
Returns void

markChatroomCommonMember

markChatroomCommonMember(_options: { account: string; custom?: string; isAdd: boolean; level?: number; done: any }): void

- Assign the membership to a guest. * Members in the chat room will receive a notification of attach.type === 'addCommon'.
- If the role of regular membership is unassigned, all members in the chat room receive a notification of type attach.type === 'removeCommon'.
There are 6 types of roles in the chat room:
- Owner
- Administrator
- Regular member
- Blocklist member
- Muted member
- Guest
Associated function
- NIMChatroomMemberInterface.markChatroomManager Assign administrator
- NIMChatroomMemberInterface.markChatroomCommonMember Assign regular member
- NIMChatroomMemberInterface.markChatroomBlacklist Add to blocklist
- NIMChatroomMemberInterface.markChatroomGaglist Add to muted members
- NIMChatroomMemberInterface.markChatroomIdentity Assign membership
- Manage roles
Parameters
- _options: { account: string; custom?: string; isAdd: boolean; level?: number; done: any }
  - account: string
    
    Account to be assigned role
  - Optional custom?: string
    
    Extension field, the value of attach.custom in the notifications.
  - isAdd: boolean
    
    true: to assign role, false: unassign role
  - Optional level?: number
    
    Level, default value: 0
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomMember): void
    - callback for the result
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomMember
      Returns void
Returns void

markChatroomGaglist

markChatroomGaglist(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void

Add a member to the list of muted members
- If a member is added to the list of muted members, other members receive a notification of type attach.type === 'gagMember'.
- If a member is removed from the list of muted members, other members in the chat room receive a notification of type attach.type === 'ungagMember'.
- Members in the list cannot send messages
Associated function
- NIMChatroomGetInstanceOptions.onmsgs
Parameters
- _options: { account: string; custom?: string; isAdd: boolean; done: any }
  - account: string
    
    Account to be assigned role
  - Optional custom?: string
    
    Extension field, the value of attach.custom in the notifications.
  - isAdd: boolean
    
    true: to assign role, false: unassign role
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomMember): void
    - callback for the result
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomMember
      Returns void
Returns void

markChatroomIdentity

markChatroomIdentity(_options: { account: string; custom?: string; identity: string; isAdd: boolean; done: any }): void

Grant the membership to a user. Members in the chat room will receive a notification message whose attach.type is one of the following:
- addManager assign the administrator role
- removeManager unassign the administrator role
- addCommon assign the regular member role
- removeCommon unassign the regular member role
- blackMember add to the blocklist
- unblackMember Remove from the blocklist
- gagMember Mute a member
- ungagMember Unmute a member
There are 6 types of roles in the chat room:
- Owner
- Administrator
- Regular member
- Blocklist member
- Muted member
- Guest
Associated function
- NIMChatroomMemberInterface.markChatroomManager Assign administrator
- NIMChatroomMemberInterface.markChatroomCommonMember Assign regular member
- NIMChatroomMemberInterface.markChatroomBlacklist Add to blocklist
- NIMChatroomMemberInterface.markChatroomGaglist Add to muted members
- NIMChatroomMemberInterface.markChatroomIdentity Assign membership
- Manage roles
Parameters
- _options: { account: string; custom?: string; identity: string; isAdd: boolean; done: any }
  - account: string
    
    Account to be assigned role
  - Optional custom?: string
    
    Extension field, the value of attach.custom in the notifications.
  - identity: string
    Role to be assigned. If the member belongs to none of the following roles, set the role to regular member.
    
    'manager'
    
    'common'
    
    'black'
    
    'mute'
  - isAdd: boolean
    
    true: to assign role, false: unassign role
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomMember): void
    - callback for the result
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomMember
      Returns void
Returns void

markChatroomManager

markChatroomManager(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void

- Only the creator of the chat room has the permission to add administrators
- Members in the chat room will receive a notification of attach.type === 'addManager'
- If an administrator is removed, all members will receive a notification of attach.type === 'removeManager'
There are 6 types of roles in the chat room:
- Owner
- Administrator
- Regular member
- Blocklist member
- Muted member
- Guest
Associated function
- NIMChatroomMemberInterface.markChatroomManager Assign administrator
- NIMChatroomMemberInterface.markChatroomCommonMember Assign regular member
- NIMChatroomMemberInterface.markChatroomBlacklist Add to blocklist
- NIMChatroomMemberInterface.markChatroomGaglist Add to muted members
- NIMChatroomMemberInterface.markChatroomIdentity Assign membership
- Manage roles
Parameters
- _options: { account: string; custom?: string; isAdd: boolean; done: any }
  - account: string
    
    Account to be assigned role
  - Optional custom?: string
    
    Extension field, the value of attach.custom in the notifications.
  - isAdd: boolean
    
    true: to assign role, false: unassign role
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomMember): void
    - callback for the result
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomMember
      Returns void
Returns void

updateChatroomMemberTempMute

updateChatroomMemberTempMute(_options: { account: string; custom?: string; duration: number; needNotify: boolean; done?: any }): void

Temporarily mute a member in a chat room. If needNotify === true, the members will receive the notification of attach.type === addTempMute
Associated function
- NIMChatroomGetInstanceOptions.onmsgs
- NIMChatroomMemberInterface.updateTagMembersTempMute
Parameters
- _options: { account: string; custom?: string; duration: number; needNotify: boolean; done?: any }
  - account: string
    
    Account
  - Optional custom?: string
    
    extension field of notifications
  - duration: number
    
    Mute duration in seconds. If the value is set to 0, a member is unmuted
  - needNotify: boolean
    
    Whether a notification is required.
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - callback
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

updateCoordinate

updateCoordinate(_options: NIMChatroomUpdateCoordinateOptions): void

Update coordinates

Parameters
- _options: NIMChatroomUpdateCoordinateOptions
Returns void

updateMyChatroomMemberInfo

updateMyChatroomMemberInfo(_options: { updateMemeberInfo: NIMChatroomUpdateMemberInfoOptions; done?: any }): void

Update the profile of the current user in a chat room

Parameters
- _options: { updateMemeberInfo: NIMChatroomUpdateMemberInfoOptions; done?: any }
  - updateMemeberInfo: NIMChatroomUpdateMemberInfoOptions
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMChatroomUpdateMemberInfoOptions): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMChatroomUpdateMemberInfoOptions
      Returns void
Returns void

updateTagMembersTempMute

updateTagMembersTempMute(_options: { custom?: string; duration: number; needNotify: boolean; notifyTargetTags?: string; tag: string; done?: any }): void

Temporarily mute a member based on the tag. If needNotify === true, the members will receive the notification of attach.type === addTempMuteTag
Associated function
- NIMChatroomGetInstanceOptions.onmsgs
- NIMChatroomMemberInterface.updateChatroomMemberTempMute
Parameters
- _options: { custom?: string; duration: number; needNotify: boolean; notifyTargetTags?: string; tag: string; done?: any }
  - Optional custom?: string
    
    extension field of notifications
  - duration: number
    
    Mute duration in seconds. If the value is set to 0, a member is unmuted
  - needNotify: boolean
    
    Whether a notification is required.
  - Optional notifyTargetTags?: string
    
    The target tag of the broadcast message, the default value is options.tag
  - tag: string
    
    Mute members with a specified tag
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - callback
      
      Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

getChatroomMemberCountByTag

Parameters

_options: { tag: string; done: any }

tag: string

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { members: NIMChatroomMember[] }

members: NIMChatroomMember[]

Returns void

Returns void

getChatroomMembers

Parameters

_options: { guest: boolean; limit?: number; onlyOnline?: boolean; time?: number; done: any }

guest: boolean

Optional limit?: number

Optional onlyOnline?: boolean

Optional time?: number

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { members: NIMChatroomMember[] }

members: NIMChatroomMember[]

Returns void

Returns void

getChatroomMembersByTag

Parameters

_options: { limit?: number; tag: string; time?: number; done: any }

Optional limit?: number

tag: string

Optional time?: number

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { members: NIMChatroomMember[] }

members: NIMChatroomMember[]

Returns void

Returns void

getChatroomMembersInfo

Parameters

_options: { accounts: string[]; done: any }

accounts: string[]

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { members: NIMChatroomMember[] }

members: NIMChatroomMember[]

Returns void

Returns void

kickChatroomMember

Associated function

Parameters

_options: { account: string; custom?: string; done?: any }

account: string

Optional custom?: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { account: string }

account: string

Returns void

Returns void

markChatroomBlacklist

Associated function

Parameters

_options: { account: string; custom?: string; isAdd: boolean; done: any }

account: string

Optional custom?: string

isAdd: boolean

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: NIMChatroomMember

Returns void

Returns void