setRoomExtraInfo method

Future<ZegoRoomSetRoomExtraInfoResult> setRoomExtraInfo(
  1. String roomID,
  2. String key,
  3. String value
)

Set room extra information.

Available since: 1.13.0 Description: The user can call this function to set the extra info of the room. Use cases: You can set some room-related business attributes, such as whether someone is Co-hosting. When to call /Trigger: After logging in the room successful. Restrictions: For restrictions on the use of this function, please refer to https://docs.zegocloud.com/article/7611 or contact ZEGO technical support. Caution: 'key' is non null. The length of key and value is limited, please refer to Restrictions. The newly set key and value will overwrite the old setting. Related callbacks: Other users in the same room will be notified through the onRoomExtraInfoUpdate callback function. Related APIs: None.

  • roomID Room ID.
  • key key of the extra info.
  • value value if the extra info.
  • Returns Set room extra info execution result notification

Implementation

Future<ZegoRoomSetRoomExtraInfoResult> setRoomExtraInfo(
    String roomID, String key, String value) async {
  return await ZegoExpressImpl.instance.setRoomExtraInfo(roomID, key, value);
}