Chat SDK for Unity and Windows v1.2.0
Public Member Functions | List of all members
AgoraChat.IRoomManagerDelegate Interface Reference

Public Member Functions

void OnDestroyedFromRoom (string roomId, string roomName)
 
void OnMemberJoinedFromRoom (string roomId, string participant)
 
void OnMemberExitedFromRoom (string roomId, string roomName, string participant)
 
void OnRemovedFromRoom (string roomId, string roomName, string participant)
 
void OnRemoveFromRoomByOffline (string roomId, string roomName)
 
void OnMuteListAddedFromRoom (string roomId, List< string > mutes, long expireTime)
 
void OnMuteListRemovedFromRoom (string roomId, List< string > mutes)
 
void OnAdminAddedFromRoom (string roomId, string admin)
 
void OnAdminRemovedFromRoom (string roomId, string admin)
 
void OnOwnerChangedFromRoom (string roomId, string newOwner, string oldOwner)
 
void OnAnnouncementChangedFromRoom (string roomId, string announcement)
 
void OnChatroomAttributesChanged (string roomId, Dictionary< string, string > kv, string from)
 
void OnChatroomAttributesRemoved (string roomId, List< string > keys, string from)
 
void OnSpecificationChangedFromRoom (Room room)
 
void OnAddAllowListMembersFromChatroom (string roomId, List< string > members)
 
void OnRemoveAllowListMembersFromChatroom (string roomId, List< string > members)
 
void OnAllMemberMuteChangedFromChatroom (string roomId, bool isAllMuted)
 

Detailed Description

The chat manager callback interface.

Member Function Documentation

◆ OnDestroyedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnDestroyedFromRoom ( string  roomId,
string  roomName 
)

Occurs when the chat room is destroyed.

Parameters
roomIdThe chat room ID.
roomNameThe chat room name.

◆ OnMemberJoinedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnMemberJoinedFromRoom ( string  roomId,
string  participant 
)

Occurs when a user joins the chat room.

Parameters
roomIdThe chat room ID.
participantThe user ID of the new member.

◆ OnMemberExitedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnMemberExitedFromRoom ( string  roomId,
string  roomName,
string  participant 
)

Occurs when a member voluntarily leaves the chat room.

Parameters
roomIdThe chat room ID.
roomNameThe name of the chat room.
participantThe user ID of the member who leaves the chat room.

◆ OnRemovedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnRemovedFromRoom ( string  roomId,
string  roomName,
string  participant 
)

Occurs when a member is removed from a chat room.

Parameters
roomIdThe chat room ID.
roomNameThe name of the chat room.
participantThe user ID of the member that is removed from a chat room.

◆ OnRemoveFromRoomByOffline()

void AgoraChat.IRoomManagerDelegate.OnRemoveFromRoomByOffline ( string  roomId,
string  roomName 
)

Occurs when a member is removed from a chat room because he or she gets offline.

Parameters
roomIdThe chat room ID.
roomNameThe name of the chat room.

◆ OnMuteListAddedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnMuteListAddedFromRoom ( string  roomId,
List< string >  mutes,
long  expireTime 
)

Occurs when a chat room member is added to the mute list.

The muted members cannot send messages during the mute duration.

Parameters
chatRoomIdThe chat room ID.
mutesThe user ID(s) of the muted member(s).
expireTimeThe mute duration in milliseconds.

◆ OnMuteListRemovedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnMuteListRemovedFromRoom ( string  roomId,
List< string >  mutes 
)

Occurs when a chat room member is removed from the mute list.

Parameters
chatRoomIdThe chat room ID.
mutesThe user ID(s) of member(s) that is removed from the mute list of the chat room.

◆ OnAdminAddedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnAdminAddedFromRoom ( string  roomId,
string  admin 
)

Occurs when a regular chat room member is set as an admin.

Parameters
roomIdThe chat room ID.
adminThe user ID of the member who is set as an admin.

◆ OnAdminRemovedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnAdminRemovedFromRoom ( string  roomId,
string  admin 
)

Occurs when an admin is demoted to a regular member.

Parameters
roomIdThe chat room ID.
adminThe user ID of the admin whose administrative permissions are removed.

◆ OnOwnerChangedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnOwnerChangedFromRoom ( string  roomId,
string  newOwner,
string  oldOwner 
)

Occurs when the chat room ownership is transferred.

Parameters
roomIdThe chat room ID.
newOwnerThe user ID of the new chat room owner.
oldOwnerThe user ID of the previous chat room owner.

◆ OnAnnouncementChangedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnAnnouncementChangedFromRoom ( string  roomId,
string  announcement 
)

Occurs when the chat room announcement is updated.

Parameters
roomIdThe chat room ID.
announcementThe updated announcement.

◆ OnChatroomAttributesChanged()

void AgoraChat.IRoomManagerDelegate.OnChatroomAttributesChanged ( string  roomId,
Dictionary< string, string >  kv,
string  from 
)

The custom chat room attribute(s) is/are updated.

All chat room members receive this event.

Parameters
chatRoomIdThe chat room ID.
kvThe map of custom chat room attributes that are updated.
fromThe user ID of the operator.

◆ OnChatroomAttributesRemoved()

void AgoraChat.IRoomManagerDelegate.OnChatroomAttributesRemoved ( string  roomId,
List< string >  keys,
string  from 
)

The custom chat room attribute(s) is/are removed.

All chat room members receive this event.

Parameters
chatRoomIdThe chat room ID.
keysThe list of keys of custom chat room attributes that are removed.
fromThe user ID of the operator.

◆ OnSpecificationChangedFromRoom()

void AgoraChat.IRoomManagerDelegate.OnSpecificationChangedFromRoom ( Room  room)

Occurs when the chat room specifications are changed.

All chat room members receive this event.

Parameters
roomThe chat room instance.

◆ OnAddAllowListMembersFromChatroom()

void AgoraChat.IRoomManagerDelegate.OnAddAllowListMembersFromChatroom ( string  roomId,
List< string >  members 
)

Occurs when the chat room member(s) is/are added to the allow list.

The members added to the allow list receive this event.

Parameters
roomIdThe chat room ID.
membersThe member(s) added to the allow list.

◆ OnRemoveAllowListMembersFromChatroom()

void AgoraChat.IRoomManagerDelegate.OnRemoveAllowListMembersFromChatroom ( string  roomId,
List< string >  members 
)

Occurs when the chat room member(s) is/are removed from the allow list.

The members that are removed from the allow list receive this event.

Parameters
roomIdThe chat room ID.
membersThe member(s) removed from the allow list.

◆ OnAllMemberMuteChangedFromChatroom()

void AgoraChat.IRoomManagerDelegate.OnAllMemberMuteChangedFromChatroom ( string  roomId,
bool  isAllMuted 
)

Occurs when all members in the chat room are muted or unmuted.

All chat room members receive this event.

Parameters
roomIdThe chat room ID.
isAllMutedWhether all chat room members are muted or unmuted.