Interface NIMChatroomGetInstanceOptions

Anonymous mode

• For the first login in anonymous mode, no account is required. To prevent the creation of a new chat room instance, the previously obtained account should be used.
• Anonymous login, isAnonymous must be set to true
• Anonymous login, the nickname is required. For non-anonymous logins, the nickname is optional. It is recommended to use the avatar

Associated function

• NIMChatroomGetInstanceOptions.isAnonymous

Associated function

• Get the address of the chat room

• 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.

Associated function

• NIMChatroomMemberInterface.getChatroomMembers

• 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.

Associated function

• NIMChatroomGetInstanceOptions.onmsgs

Example

// User A logs in
 Chatroom.getInstance({
   "account": "A",
   "chatroomEnterCustom": "{'enterCustom': 'enterCustom'}"
 })

// Logged-in User B gets notified by onmsgs
 Chatroom.getInstance({
   "account": "B",
   "onmsgs": function(msg) {
      if (msg.type === 'notification' && msg.attach.type === 'memberEnter') {
        // {'enterCustom': 'enterCustom'}
        console.log(msg.attach.custom)
      }
   }
 })

Associated function

• Create a chat room

Associated function

• NIMChatroomGetInstanceOptions.isAnonymous

Note: The default client types are only Web, PC, AOS, and iOS. If you want to distinguish more types, such as WeChat Mini Program and other environments, they can use this field to map the values.

Note: This field is often used during login. Get notified when the account is logged in on other devices. You can configure a custom setting.

Associated function

• NIMChatroomGetInstanceOptions.account
• NIMChatroomGetInstanceOptions.chatroomNick

• off: do not output any logs
• debug: output debug, info, warn and error level logs
• info: output info, warn, and error level logs
• warn: output warn and error level logs
• error: output error level logs

• 0: Authentication using static tokens. The static token remains unchanged and is permanently valid by default, unless you refresh token using the server API.
• 1: Authentication using dynamic tokens. Dynamic tokens can be configured with a validity period and are time-sensitive. This authentication method can effectively increase the security and reduce the risk of password leakage. For information about how to generate dynamic tokens, see: dynamic token
• 2: Authentication using third-party webhooks. The CommsEase server does not perform IM login authentication, and the authentication must be performed by a designated third-party server (your app server).

Note: the extension is synced with the app server, and will not be synchronized to other devices.

Notes

• The connection is closed due to network, heartbeat timeout and other reasons, and the SDK provides automatic reconnection
• The interval for reconnection is accumulated from 1.6 to 8s, and each reconnection will trigger the onwillreconnect event

If unspecified, the server will automatically generate a tag expression according to NIMChatroomGetInstanceOptions.tags.

The generation rule is to combine all the tags in the and keyword. Only users who have all the tags can receive the notifications for joining and leaving the chat room.

Associated function

• NIMChatroomGetInstanceOptions.tags
• Tags

In secure mode, a connection will be established with the server using HTTPS protocol, and in non-secure mode, a connection will be established with the server using HTTP protocol, the default value is true.

Supported since v9.12.0 The maximum number of Socket concurrent connections. Valid values: an integer between 1 and 3. The default value is 1, no concurrent connections are supported. If you need more Socket connections, you can set this parameter.

Associated function

• NIMChatroomGetInstanceOptions.notifyTargetTags
• Tags