NIMChatroomManager Protocol Reference
| Conforms to | NSObject |
|---|---|
| Declared in | NIMChatroomManagerProtocol.h |
– enterChatroom:completion:
required method
Join a chat room
- (void)enterChatroom:(NIMChatroomEnterRequest *)request completion:(nullable NIMChatroomEnterHandler)completionParameters
request |
request to join a chat room |
|---|---|
completion |
completion callback |
Discussion
Join a chat room
Declared In
NIMChatroomManagerProtocol.h
– exitChatroom:completion:
required method
Leave a chat room
- (void)exitChatroom:(NSString *)roomId completion:(nullable NIMChatroomHandler)completionParameters
roomId |
chat room ID |
|---|---|
completion |
completion callback |
Discussion
Leave a chat room
Declared In
NIMChatroomManagerProtocol.h
– chatroomAuthMode:
required method
Login mode for chat rooms
- (NSInteger)chatroomAuthMode:(NSString *)roomIdParameters
roomId |
chat room ID |
|---|
Return Value
login mode
Discussion
Login mode for chat rooms
Declared In
NIMChatroomManagerProtocol.h
– fetchMessageHistory:option:result:
required method
Query the chat room message records stored on the server
- (void)fetchMessageHistory:(NSString *)roomId option:(NIMHistoryMessageSearchOption *)option result:(nullable NIMFetchChatroomHistoryBlock)resultParameters
roomId |
chat room ID |
|---|---|
option |
Search option |
result |
Completion callback |
Discussion
Query the chat room message records stored on the server
Declared In
NIMChatroomManagerProtocol.h
– fetchChatroomInfo:completion:
required method
Get the chat room info
- (void)fetchChatroomInfo:(NSString *)roomId completion:(nullable NIMChatroomInfoHandler)completionParameters
roomId |
chat room ID |
|---|---|
completion |
completion callback |
Discussion
Get the chat room info
You can get the chat room information only if you have joined the chat room
Declared In
NIMChatroomManagerProtocol.h
– updateChatroomInfo:completion:
required method
Update the chat room info
- (void)updateChatroomInfo:(NIMChatroomUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to edit the chat room info |
|---|---|
completion |
completion callback |
Discussion
Update the chat room info
Declared In
NIMChatroomManagerProtocol.h
– updateMyChatroomMemberInfo:completion:
required method
Edit the personal profile in the chat room
- (void)updateMyChatroomMemberInfo:(NIMChatroomMemberInfoUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to edit the personal profile displayed in a chat room |
|---|---|
completion |
Completion callback |
Discussion
Edit the personal profile in the chat room
Declared In
NIMChatroomManagerProtocol.h
– fetchChatroomMembers:completion:
required method
Get members in a chat room
- (void)fetchChatroomMembers:(NIMChatroomMemberRequest *)request completion:(nullable NIMChatroomMembersHandler)completionParameters
request |
request to get the members |
|---|---|
completion |
completion callback |
Discussion
Get members in a chat room
Declared In
NIMChatroomManagerProtocol.h
– fetchChatroomMembersByIds:completion:
required method
Get member profiles based on user IDs
- (void)fetchChatroomMembersByIds:(NIMChatroomMembersByIdsRequest *)request completion:(nullable NIMChatroomMembersHandler)completionParameters
request |
request to get the members |
|---|---|
completion |
completion callback |
Discussion
Get member profiles based on user IDs
Declared In
NIMChatroomManagerProtocol.h
– fetchChatroomMembersByTag:completion:
required method
Get the members by tag in the chat room
- (void)fetchChatroomMembersByTag:(NIMChatroomFetchMembersByTagRequest *)request completion:(nullable NIMChatroomMembersHandler)completionParameters
request |
request to get members by tag |
|---|---|
completion |
completion callback |
Discussion
Get the members by tag in the chat room
Declared In
NIMChatroomManagerProtocol.h
– queryChatroomMembersCountByTag:completion:
required method
query the online members by tag in the chat room
- (void)queryChatroomMembersCountByTag:(NIMChatroomQueryMembersCountByTagRequest *)request completion:(nullable NIMChatroomMembersCountHandler)completionParameters
request |
request to get members by tag |
|---|---|
completion |
completion callback |
Discussion
query the online members by tag in the chat room
Declared In
NIMChatroomManagerProtocol.h
– updateLocation:completion:
required method
Update coordinates
- (void)updateLocation:(nonnull NIMChatroomLocation *)location completion:(nullable NIMChatroomHandler)completionParameters
location |
current coordinates and effective distance |
|---|---|
completion |
completion callback |
Discussion
Update coordinates
Declared In
NIMChatroomManagerProtocol.h
– updateTags:completion:
required method
Update tags
- (void)updateTags:(nonnull NIMChatroomTagsUpdate *)tags completion:(nullable NIMChatroomHandler)completionParameters
tags |
tags |
|---|---|
completion |
completion callback |
Discussion
Update tags
Declared In
NIMChatroomManagerProtocol.h
– markMemberManager:completion:
required method
Mark as administrator in a chat room
- (void)markMemberManager:(NIMChatroomMemberUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
completion |
completion callback |
Discussion
Mark as administrator in a chat room
Declared In
NIMChatroomManagerProtocol.h
– markNormalMember:completion:
required method
Mark as member in a chat room
- (void)markNormalMember:(NIMChatroomMemberUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
completion |
completion callback |
Discussion
Mark as member in a chat room
Declared In
NIMChatroomManagerProtocol.h
– updateMemberBlack:completion:
required method
Update the blacklist in a chat room
- (void)updateMemberBlack:(NIMChatroomMemberUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
completion |
completion callback |
Discussion
Update the blacklist in a chat room
Declared In
NIMChatroomManagerProtocol.h
– updateMemberMute:completion:
required method
Update the list of muted members in a chat room
- (void)updateMemberMute:(NIMChatroomMemberUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
completion |
completion callback |
Discussion
Update the list of muted members in a chat room
Declared In
NIMChatroomManagerProtocol.h
– updateMemberTempMute:duration:completion:
required method
Update the list of temporarily muted members in a chat room
- (void)updateMemberTempMute:(NIMChatroomMemberUpdateRequest *)request duration:(unsigned long long)duration completion:(nullable NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
duration |
duration of a mute state in seconds |
completion |
completion callback |
Discussion
Update the list of temporarily muted members in a chat room
Declared In
NIMChatroomManagerProtocol.h
– tempMuteTag:completion:
required method
Update the mute state by tag in a chat room
- (void)tempMuteTag:(NIMChatroomTempMuteTagRequest *)request completion:(NIMChatroomHandler)completionParameters
request |
request to update the role |
|---|---|
completion |
completion callback |
duration |
duration of a mute state in seconds |
Discussion
Update the mute state by tag in a chat room
Declared In
NIMChatroomManagerProtocol.h
– kickMember:completion:
required method
Remove a specified member from a chat room
- (void)kickMember:(NIMChatroomMemberKickRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
request to remove a specified member from the chat room |
|---|---|
completion |
completion callback |
Discussion
Remove a specified member from a chat room
Declared In
NIMChatroomManagerProtocol.h
– updateChatroomQueueObject:completion:
required method
Add or update common queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
- (void)updateChatroomQueueObject:(NIMChatroomQueueUpdateRequest *)request completion:(nullable NIMChatroomHandler)completionParameters
request |
Queue request to a chat room |
|---|---|
completion |
completion callback |
Discussion
Add or update common queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
Declared In
NIMChatroomManagerProtocol.h
– removeChatroomQueueObject:completion:
required method
Remove queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
- (void)removeChatroomQueueObject:(NIMChatroomQueueRemoveRequest *)request completion:(nullable NIMChatroomQueueRemoveHandler)completionParameters
request |
request to get queue elements |
|---|---|
completion |
completion callback |
Discussion
Remove queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
Declared In
NIMChatroomManagerProtocol.h
– fetchChatroomQueue:completion:
required method
Get the chat room queue
- (void)fetchChatroomQueue:(NSString *)roomId completion:(nullable NIMChatroomQueueInfoHandler)completionParameters
roomId |
chat room ID |
|---|---|
completion |
completion callback |
Discussion
Get the chat room queue
Declared In
NIMChatroomManagerProtocol.h
– dropChatroomQueue:completion:
required method
Delete the queue in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
- (void)dropChatroomQueue:(NSString *)roomId completion:(nullable NIMChatroomHandler)completionParameters
roomId |
chat room ID |
|---|---|
completion |
completion callback |
Discussion
Delete the queue in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
Declared In
NIMChatroomManagerProtocol.h
– batchUpdateChatroomQueueObject:completion:
required method
Update multiple common queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
- (void)batchUpdateChatroomQueueObject:(NIMChatroomQueueBatchUpdateRequest *)request completion:(nullable NIMChatroomQueueBatchUpdateHandler)completionParameters
request |
Multiple requests to update the chat room queue |
|---|---|
completion |
completion callback |
Discussion
Update multiple common queue elements in a chat room. The permission is granted by the queueModificationLevel of NIMChatroom
Declared In
NIMChatroomManagerProtocol.h
– addDelegate:
required method
Add a notification object
- (void)addDelegate:(id<NIMChatroomManagerDelegate>)delegateParameters
delegate |
notification object |
|---|
Discussion
Add a notification object
Declared In
NIMChatroomManagerProtocol.h
– removeDelegate:
required method
Remove the object for notification
- (void)removeDelegate:(id<NIMChatroomManagerDelegate>)delegateParameters
delegate |
notification object |
|---|
Discussion
Remove the object for notification
Declared In
NIMChatroomManagerProtocol.h