12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259 |
- /*!
- * \~chinese
- * @header IEMChatroomManager.h
- * @abstract 此协议定义了聊天室相关操作
- * @author Hyphenate
- * @version 3.00
- *
- * \~english
- * @header IEMChatroomManager.h
- * @abstract This protocol defines the chat room operations
- * @author Hyphenate
- * @version 3.00
- */
- #import <Foundation/Foundation.h>
- #import "EMCommonDefs.h"
- #import "EMChatroomManagerDelegate.h"
- #import "EMChatroomOptions.h"
- #import "EMChatroom.h"
- #import "EMPageResult.h"
- #import "EMCursorResult.h"
- @class EMError;
- /*!
- * \~chinese
- * 聊天室相关操作
- *
- * \~english
- * Chatroom operations
- */
- @protocol IEMChatroomManager <NSObject>
- @required
- #pragma mark - Delegate
- /*!
- * \~chinese
- * 添加回调代理
- *
- * @param aDelegate 要添加的代理
- * @param aQueue 添加回调代理
- *
- * \~english
- * Add delegate
- *
- * @param aDelegate Delegate
- * @param aQueue (optional) The queue of calling delegate methods. Pass in nil to run on main thread.
- */
- - (void)addDelegate:(id<EMChatroomManagerDelegate>)aDelegate
- delegateQueue:(dispatch_queue_t)aQueue;
- /*!
- * \~chinese
- * 移除回调代理
- *
- * @param aDelegate 要移除的代理
- *
- * \~english
- * Remove delegate
- *
- * @param aDelegate Delegate
- */
- - (void)removeDelegate:(id<EMChatroomManagerDelegate>)aDelegate;
- #pragma mark - Fetch Chatrooms
- /*!
- * \~chinese
- * 从服务器获取指定数目的聊天室
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param pError 出错信息
- *
- * @return 聊天室列表<EMChatroom>
- *
- * \~english
- * Get pagesize number chatroom from server.
- *
- * Synchronization method will block the current thread
- *
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param pError Error
- *
- * @return Chat room list<EMChatroom>
- */
- - (EMPageResult *)getChatroomsFromServerWithPage:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 从服务器获取指定数目的聊天室
- *
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Get all the chatrooms from server
- *
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomsFromServerWithPage:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- completion:(void (^)(EMPageResult *aResult, EMError *aError))aCompletionBlock;
- #pragma mark - Create
- /*!
- * \~chinese
- * 创建聊天室
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aSubject 名称
- * @param aDescription 描述
- * @param aInvitees 成员(不包括创建者自己)
- * @param aMessage 邀请消息
- * @param aMaxMembersCount 群组最大成员数
- * @param pError 出错信息
- *
- * @return 创建的聊天室
- *
- * \~english
- * Create a chatroom
- *
- * Synchronization method will block the current thread
- *
- * @param aSubject Subject
- * @param aDescription Description
- * @param aInvitees Members, without creater
- * @param aMessage Invitation message
- * @param aMaxMembersCount Max members count
- * @param pError Error
- *
- * @return Created chatroom
- */
- - (EMChatroom *)createChatroomWithSubject:(NSString *)aSubject
- description:(NSString *)aDescription
- invitees:(NSArray *)aInvitees
- message:(NSString *)aMessage
- maxMembersCount:(NSInteger)aMaxMembersCount
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 创建群组
- *
- * @param aSubject 群组名称
- * @param aDescription 群组描述
- * @param aInvitees 群组成员(不包括创建者自己)
- * @param aMessage 邀请消息
- * @param aMaxMembersCount 群组最大成员数
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Create a group
- *
- * @param aSubject Group subject
- * @param aDescription Group description
- * @param aInvitees Group members, without creater
- * @param aMessage Invitation message
- * @param aMaxMembersCount Max members count
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)createChatroomWithSubject:(NSString *)aSubject
- description:(NSString *)aDescription
- invitees:(NSArray *)aInvitees
- message:(NSString *)aMessage
- maxMembersCount:(NSInteger)aMaxMembersCount
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- #pragma mark - Edit Chatroom
- /*!
- * \~chinese
- * 加入聊天室
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室的ID
- * @param pError 返回的错误信息
- *
- * @result 所加入的聊天室
- *
- * \~english
- * Join a chatroom
- *
- * Synchronization method will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Joined chatroom
- */
- - (EMChatroom *)joinChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 加入聊天室
- *
- * @param aChatroomId 聊天室的ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Join a chatroom
- *
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)joinChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 退出聊天室
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- *
- * \~english
- * Leave a chatroom
- *
- * Synchronization method will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- */
- - (void)leaveChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 退出聊天室
- *
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Leave a chatroom
- *
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)leaveChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 解散聊天室, 需要owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室ID
- *
- * @result 错误信息, 成功返回nil
- *
- * \~english
- * Destroy a group, owner‘s authority is required
- *
- * Synchronization method will block the current thread
- *
- * @param aChatroomId Chatroom id
- *
- * @result Error, return nil if success
- */
- - (EMError *)destroyChatroom:(NSString *)aChatroomId;
- /*!
- * \~chinese
- * 解散群组, 需要owner权限
- *
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Destroy a group, owner‘s authority is required
- *
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)destroyChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMError *aError))aCompletionBlock;
- #pragma mark - Fetch
- /*!
- * \~chinese
- * 获取聊天室详情
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @return 聊天室
- *
- * \~english
- * Fetch chatroom's specification
- *
- * Synchronization method, will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @return Chatroom instance
- */
- - (EMChatroom *)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 获取聊天室详情
- *
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Fetch chat room specifications
- *
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 获取聊天室成员列表
- *
- * @param aChatroomId 聊天室ID
- * @param aCursor 游标,首次调用传空
- * @param aPageSize 获取多少条
- * @param pError 错误信息
- *
- * @return 列表和游标
- *
- * \~english
- * Get the list of chatroom members from the server
- *
- * @param aChatroomId Chatroom id
- * @param aCursor Cursor, input nil the first time
- * @param aPageSize Page size
- * @param pError Error
- *
- * @return List and cursor
- *
- */
- - (EMCursorResult *)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
- cursor:(NSString *)aCursor
- pageSize:(NSInteger)aPageSize
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 获取聊天室成员列表
- *
- * @param aChatroomId 聊天室ID
- * @param aCursor 游标,首次调用传空
- * @param aPageSize 获取多少条
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Get the list of chatroom members from the server
- *
- * @param aChatroomId Chatroom id
- * @param aCursor Cursor, input nil the first time
- * @param aPageSize Page size
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
- cursor:(NSString *)aCursor
- pageSize:(NSInteger)aPageSize
- completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 获取聊天室黑名单列表, 需要owner/admin权限
- *
- * @param aChatroomId 聊天室ID
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param pError 错误信息
- *
- *
- * \~english
- * Get the blacklist of chatroom from the server, need owner / admin permissions
- *
- * @param aChatroomId Chatroom id
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param pError Error
- *
- */
- - (NSArray *)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
- pageNumber:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 获取聊天室黑名单列表, 需要owner/admin权限
- *
- * @param aChatroomId 聊天室ID
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Get chatroom's blacklist, need owner / admin permissions
- *
- * @param aChatroomId Chatroom id
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
- pageNumber:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 获取聊天室被禁言列表
- *
- * @param aChatroomId 聊天室ID
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param pError 错误信息
- *
- *
- * \~english
- * Get the mutes of chatroom from the server
- *
- * @param aChatroomId Chatroom id
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param pError Error
- *
- */
- - (NSArray *)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
- pageNumber:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 获取聊天室被禁言列表
- *
- * @param aChatroomId 聊天室ID
- * @param aPageNum 获取第几页
- * @param aPageSize 获取多少条
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Get the mutes of chatroom from the server
- *
- * @param aChatroomId Chatroom id
- * @param aPageNum Page number
- * @param aPageSize Page size
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
- pageNumber:(NSInteger)aPageNum
- pageSize:(NSInteger)aPageSize
- completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 获取聊天室公告
- *
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @return 聊天室公告
- *
- * \~english
- * Get the announcement of chatroom from the server
- *
- * @param aChatroomId Chatroom id
- * @param pError error
- *
- * @return The announcement of chatroom
- */
- - (NSString *)getChatroomAnnouncementWithId:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 获取聊天室公告
- *
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Get the announcement of chatroom from the server
- *
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomAnnouncementWithId:(NSString *)aChatroomId
- completion:(void (^)(NSString *aAnnouncement, EMError *aError))aCompletionBlock;
- #pragma mark - Edit
- /*!
- * \~chinese
- * 更改聊天室主题, 需要owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aSubject 新主题
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室对象
- *
- * \~english
- * Change chatroom subject, owner‘s authority is required
- *
- * Synchronization method will block the current thread
- *
- * @param aSubject New subject
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)updateSubject:(NSString *)aSubject
- forChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 更改聊天室主题, 需要owner权限
- *
- * @param aSubject 新主题
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Change the chatroom subject, owner‘s authority is required
- *
- * @param aSubject New subject
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)updateSubject:(NSString *)aSubject
- forChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 更改聊天室说明信息, 需要owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aDescription 说明信息
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室对象
- *
- * \~english
- * Change chatroom description, owner‘s authority is required
- *
- * Synchronization method will block the current thread
- *
- * @param aDescription New description
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom
- */
- - (EMChatroom *)updateDescription:(NSString *)aDescription
- forChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 更改聊天室说明信息, 需要owner权限
- *
- * @param aDescription 说明信息
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Change the chatroom description, owner‘s authority is required
- *
- * @param aDescription New description
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)updateDescription:(NSString *)aDescription
- forChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 将成员移出聊天室, 需要owner/admin权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aMembers 要移出的用户列表
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Remove members from a chatroom, required owner‘s authority
- *
- * Synchronization method will block the current thread
- *
- * @param aMembers Users to be removed
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)removeMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 将成员移出聊天室, 需要owner/admin权限
- *
- * @param aMembers 要移出的用户列表
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Remove members from a group, owner‘s authority is required
- *
- * @param aMembers Users to be removed
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)removeMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 加人到聊天室黑名单, 需要owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aMembers 要加入黑名单的用户
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Add users to chatroom blacklist, required owner‘s authority
- *
- * Synchronization method will block the current thread
- *
- * @param aMembers Users to be added
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)blockMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 加人到聊天室黑名单, 需要owner权限
- *
- * @param aMembers 要加入黑名单的用户
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Add users to chatroom blacklist, owner‘s authority is required
- *
- * @param aMembers Users to be added
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)blockMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 从聊天室黑名单中减人, 需要owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aMembers 要从黑名单中移除的用户名列表
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室对象
- *
- * \~english
- * Remove users from chatroom blacklist, required owner‘s authority
- *
- * Synchronization method will block the current thread
- *
- * @param aMembers Users to be removed
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)unblockMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 从聊天室黑名单中减人, 需要owner权限
- *
- * @param aMembers 要从黑名单中移除的用户名列表
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Remove users from chatroom blacklist, owner‘s authority is required
- *
- * @param aMembers Users to be removed
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)unblockMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 改变聊天室创建者,需要Owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室ID
- * @param aNewOwner 新Owner
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Change chatroom owner, need Owner permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param aNewOwner New owner
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)updateChatroomOwner:(NSString *)aChatroomId
- newOwner:(NSString *)aNewOwner
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 改变聊天室创建者,需要Owner权限
- *
- * @param aChatroomId 聊天室ID
- * @param aNewOwner 新Owner
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Change chatroom owner, need Owner permissions
- *
- * @param aChatroomId Chatroom id
- * @param aNewOwner New owner
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)updateChatroomOwner:(NSString *)aChatroomId
- newOwner:(NSString *)aNewOwner
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 添加聊天室管理员,需要Owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aAdmin 要添加的管理员
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Add chatroom admin, need Owner permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aAdmin Admin
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Group instance
- */
- - (EMChatroom *)addAdmin:(NSString *)aAdmin
- toChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 添加聊天室管理员,需要Owner权限
- *
- * @param aAdmin 要添加的群组管理员
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Add chatroom admin, need Owner permissions
- *
- * @param aAdmin Admin
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)addAdmin:(NSString *)aAdmin
- toChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroomp, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 移除聊天室管理员,需要Owner权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aAdmin 要移除的群组管理员
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Remove chatroom admin, need Owner permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aAdmin Admin
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)removeAdmin:(NSString *)aAdmin
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 移除聊天室管理员,需要Owner权限
- *
- * @param aAdmin 要添加的群组管理员
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- *
- * \~english
- * Remove chatroom admin, need Owner permissions
- *
- * @param aAdmin Admin
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)removeAdmin:(NSString *)aAdmin
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 将一组成员禁言,需要Owner / Admin权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aMuteMembers 要禁言的成员列表<NSString>
- * @param aMuteMilliseconds 禁言时长
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Mute chatroom members, need Owner / Admin permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aMuteMembers The list of mute, type is <NSString>
- * @param aMuteMilliseconds Muted time duration in millisecond
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)muteMembers:(NSArray *)aMuteMembers
- muteMilliseconds:(NSInteger)aMuteMilliseconds
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 将一组成员禁言,需要Owner / Admin权限
- *
- * @param aMuteMembers 要禁言的成员列表<NSString>
- * @param aMuteMilliseconds 禁言时长
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Mute chatroom members, need Owner / Admin permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aMuteMembers The list of mute, type is <NSString>
- * @param aMuteMilliseconds Muted time duration in millisecond
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)muteMembers:(NSArray *)aMuteMembers
- muteMilliseconds:(NSInteger)aMuteMilliseconds
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 解除禁言,需要Owner / Admin权限
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aMuteMembers 被解除的列表<NSString>
- * @param aChatroomId 聊天室ID
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Unmute chatroom members, need Owner / Admin permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aMembers The list of unmute, type is <NSString>
- * @param aChatroomId Chatroom id
- * @param pError Error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)unmuteMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 解除禁言,需要Owner / Admin权限
- *
- * @param aMuteMembers 被解除的列表<NSString>
- * @param aChatroomId 聊天室ID
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Unmute chatroom members, need Owner / Admin permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aMembers The list of unmute, type is <NSString>
- * @param aChatroomId Chatroom id
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)unmuteMembers:(NSArray *)aMembers
- fromChatroom:(NSString *)aChatroomId
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- /*!
- * \~chinese
- * 修改聊天室公告,需要Owner / Admin权限
- *
- * @param aChatroomId 聊天室ID
- * @param aAnnouncement 群公告
- * @param pError 错误信息
- *
- * @result 聊天室实例
- *
- * \~english
- * Change the announcement of chatroom, need Owner / Admin permissions
- *
- * Synchronization method will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param aAnnouncement announcement of chatroom
- * @param pError error
- *
- * @result Chatroom instance
- */
- - (EMChatroom *)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
- announcement:(NSString *)aAnnouncement
- error:(EMError **)pError;
- /*!
- * \~chinese
- * 修改聊天室公告,需要Owner / Admin权限
- *
- * @param aChatroomId 聊天室ID
- * @param aAnnouncement 群公告
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Change the announcement of chatroom, need Owner / Admin permissions
- *
- * @param aChatroomId Chatroom id
- * @param aAnnouncement announcement of chatroom
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
- announcement:(NSString *)aAnnouncement
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
- #pragma mark - EM_DEPRECATED_IOS 3.3.0
- /*!
- * \~chinese
- * 获取聊天室详情
- *
- * 同步方法,会阻塞当前线程
- *
- * @param aChatroomId 聊天室ID
- * @param aIncludeMembersList 是否获取成员列表,为YES时,返回200个成员
- * @param pError 错误信息
- *
- * @return 聊天室
- *
- * \~english
- * Fetch chatroom's specification
- *
- * Synchronization method, will block the current thread
- *
- * @param aChatroomId Chatroom id
- * @param aIncludeMembersList Whether to get member list,When YES, returns 200 members
- * @param pError Error
- *
- * @return Chatroom instance
- */
- - (EMChatroom *)fetchChatroomInfo:(NSString *)aChatroomId
- includeMembersList:(BOOL)aIncludeMembersList
- error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:error:]");
- /*!
- * \~chinese
- * 获取聊天室详情
- *
- * @param aChatroomId 聊天室ID
- * @param aIncludeMembersList 是否获取成员列表,为YES时,返回200个成员
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Fetch chat room specifications
- *
- * @param aChatroomId Chatroom id
- * @param aIncludeMembersList Whether to get member list,When YES, returns 200 members
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getChatroomSpecificationFromServerByID:(NSString *)aChatroomId
- includeMembersList:(BOOL)aIncludeMembersList
- completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:completion:]");
- #pragma mark - EM_DEPRECATED_IOS 3.2.3
- /*!
- * \~chinese
- * 添加回调代理
- *
- * @param aDelegate 要添加的代理
- *
- * \~english
- * Add delegate
- *
- * @param aDelegate Delegate
- */
- - (void)addDelegate:(id<EMChatroomManagerDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMChatroomManager addDelegate:delegateQueue:]");
- #pragma mark - EM_DEPRECATED_IOS < 3.2.3
- /*!
- * \~chinese
- * 从服务器获取所有的聊天室
- *
- * 同步方法,会阻塞当前线程
- *
- * @param pError 出错信息
- *
- * @return 聊天室列表<EMChatroom>
- *
- * \~english
- * Get all the chatrooms from server
- *
- * Synchronization method will block the current thread
- *
- * @param pError Error
- *
- * @return Chat room list<EMChatroom>
- */
- - (NSArray *)getAllChatroomsFromServerWithError:(EMError **)pError __deprecated_msg("Use -getChatroomsFromServerWithPage");
- /*!
- * \~chinese
- * 从服务器获取所有的聊天室
- *
- * @param aCompletionBlock 完成的回调
- *
- * \~english
- * Get all the chatrooms from server
- *
- * @param aCompletionBlock The callback block of completion
- *
- */
- - (void)getAllChatroomsFromServerWithCompletion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock __deprecated_msg("Use -getChatroomsFromServerWithPage");
- /*!
- * \~chinese
- * 从服务器获取所有的聊天室
- *
- * @param aSuccessBlock 成功的回调
- * @param aFailureBlock 失败的回调
- *
- * \~english
- * Get all the chatrooms from server
- *
- * @param aSuccessBlock The callback block of success
- * @param aFailureBlock The callback block of failure
- *
- */
- - (void)asyncGetAllChatroomsFromServer:(void (^)(NSArray *aList))aSuccessBlock
- failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getAllChatroomsFromServerWithCompletion:");
- /*!
- * \~chinese
- * 加入聊天室
- *
- * @param aChatroomId 聊天室的ID
- * @param aSuccessBlock 成功的回调
- * @param aFailureBlock 失败的回调
- *
- *
- * \~english
- * Join a chatroom
- *
- * @param aChatroomId Chatroom id
- * @param aSuccessBlock The callback block of success
- * @param aFailureBlock The callback block of failure
- *
- */
- - (void)asyncJoinChatroom:(NSString *)aChatroomId
- success:(void (^)(EMChatroom *aRoom))aSuccessBlock
- failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -joinChatroom:completion:");
- /*!
- * \~chinese
- * 退出聊天室
- *
- * @param aChatroomId 聊天室ID
- * @param aSuccessBlock 成功的回调
- * @param aFailureBlock 失败的回调
- *
- * @result 退出的聊天室
- *
- * \~english
- * Leave a chatroom
- *
- * @param aChatroomId Chatroom id
- * @param aSuccessBlock The callback block of success
- * @param aFailureBlock The callback block of failure
- *
- * @result Leaved chatroom
- */
- - (void)asyncLeaveChatroom:(NSString *)aChatroomId
- success:(void (^)(EMChatroom *aRoom))aSuccessBlock
- failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -leaveChatroom:completion:");
- /*!
- * \~chinese
- * 获取聊天室详情
- *
- * @param aChatroomId 聊天室ID
- * @param aIncludeMembersList 是否获取成员列表
- * @param aSuccessBlock 成功的回调
- * @param aFailureBlock 失败的回调
- *
- * \~english
- * Fetch chatroom's specification
- *
- * @param aChatroomId Chatroom id
- * @param aIncludeMembersList Whether get member list
- * @param aSuccessBlock The callback block of success
- * @param aFailureBlock The callback block of failure
- *
- */
- - (void)asyncFetchChatroomInfo:(NSString *)aChatroomId
- includeMembersList:(BOOL)aIncludeMembersList
- success:(void (^)(EMChatroom *aChatroom))aSuccessBlock
- failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getChatroomSpecificationFromServerByID:includeMembersList:completion:");
- @end
|