IEMGroupManager.h 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822
  1. /*!
  2. * \~chinese
  3. * @header IEMGroupManager.h
  4. * @abstract 此协议定义了群组相关操作
  5. * @author Hyphenate
  6. * @version 3.00
  7. *
  8. * \~english
  9. * @header IEMGroupManager.h
  10. * @abstract This protocol defines the group operations
  11. * @author Hyphenate
  12. * @version 3.00
  13. */
  14. #import <Foundation/Foundation.h>
  15. #import "EMCommonDefs.h"
  16. #import "EMGroupManagerDelegate.h"
  17. #import "EMGroup.h"
  18. #import "EMGroupOptions.h"
  19. #import "EMCursorResult.h"
  20. #import "EMGroupSharedFile.h"
  21. /*!
  22. * \~chinese
  23. * 群组相关操作
  24. *
  25. * \~english
  26. * Group operations
  27. */
  28. @protocol IEMGroupManager <NSObject>
  29. @required
  30. #pragma mark - Delegate
  31. /*!
  32. * \~chinese
  33. * 添加回调代理
  34. *
  35. * @param aDelegate 要添加的代理
  36. * @param aQueue 添加回调代理
  37. *
  38. * \~english
  39. * Add delegate
  40. *
  41. * @param aDelegate Delegate
  42. * @param aQueue (optional) The queue of calling delegate methods. Pass in nil to run on main thread.
  43. */
  44. - (void)addDelegate:(id<EMGroupManagerDelegate>)aDelegate
  45. delegateQueue:(dispatch_queue_t)aQueue;
  46. /*!
  47. * \~chinese
  48. * 移除回调代理
  49. *
  50. * @param aDelegate 要移除的代理
  51. *
  52. * \~english
  53. * Remove delegate
  54. *
  55. * @param aDelegate Delegate
  56. */
  57. - (void)removeDelegate:(id)aDelegate;
  58. #pragma mark - Get Group
  59. /*!
  60. * \~chinese
  61. * 获取用户所有群组
  62. *
  63. * @result 群组列表<EMGroup>
  64. *
  65. * \~english
  66. * Get all groups
  67. *
  68. * @result Group list<EMGroup>
  69. *
  70. */
  71. - (NSArray *)getJoinedGroups;
  72. /*!
  73. * \~chinese
  74. * 从内存中获取屏蔽了推送的群组ID列表
  75. *
  76. * @param pError 错误信息
  77. *
  78. * \~english
  79. * Get the list of groups which have disabled Apple Push Notification Service
  80. *
  81. * @param pError Error
  82. */
  83. - (NSArray *)getGroupsWithoutPushNotification:(EMError **)pError;
  84. #pragma mark - Get group from server
  85. /*!
  86. * \~chinese
  87. * 按数目从服务器获取自己加入的群组
  88. *
  89. * 同步方法,会阻塞当前线程
  90. *
  91. * @param aPageNum 获取自己加入群的cursor,首次调用传空
  92. * @param aPageSize 期望返回结果的数量, 如果 < 0 则一次返回所有结果
  93. * @param pError 出错信息
  94. *
  95. * @return 群组列表<EMGroup>
  96. *
  97. * \~english
  98. * Get pagesize number group you joined from the server.
  99. *
  100. * Synchronization method will block the current thread
  101. *
  102. * @param aPageNum Page number
  103. * @param aPageSize Page size
  104. * @param pError Error
  105. *
  106. * @return Group list<EMGroup>
  107. */
  108. - (NSArray *)getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum
  109. pageSize:(NSInteger)aPageSize
  110. error:(EMError **)pError;
  111. /*!
  112. * \~chinese
  113. * 按数目从服务器获取自己加入的群组
  114. *
  115. * @param aPageNum 获取自己加入群的cursor,首次调用传空
  116. * @param aPageSize 期望返回结果的数量, 如果 < 0 则一次返回所有结果
  117. * @param aCompletionBlock 完成的回调
  118. *
  119. * \~english
  120. * Get pagesize number group you joined from the server.
  121. *
  122. * @param aPageNum Page number
  123. * @param aPageSize Page size
  124. * @param aCompletionBlock The callback block of completion
  125. *
  126. */
  127. - (void)getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum
  128. pageSize:(NSInteger)aPageSize
  129. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
  130. /*!
  131. * \~chinese
  132. * 从服务器获取指定范围内的公开群
  133. *
  134. * 同步方法,会阻塞当前线程
  135. *
  136. * @param aCursor 获取公开群的cursor,首次调用传空
  137. * @param aPageSize 期望返回结果的数量, 如果 < 0 则一次返回所有结果
  138. * @param pError 出错信息
  139. *
  140. * @return 获取的公开群结果
  141. *
  142. * \~english
  143. * Get public groups with the specified range from the server
  144. *
  145. * Synchronization method will block the current thread
  146. *
  147. * @param aCursor Cursor, input nil the first time
  148. * @param aPageSize Expect result count, return all results if count is less than zero
  149. * @param pError Error
  150. *
  151. * @return The result
  152. */
  153. - (EMCursorResult *)getPublicGroupsFromServerWithCursor:(NSString *)aCursor
  154. pageSize:(NSInteger)aPageSize
  155. error:(EMError **)pError;
  156. /*!
  157. * \~chinese
  158. * 从服务器获取指定范围内的公开群
  159. *
  160. * @param aCursor 获取公开群的cursor,首次调用传空
  161. * @param aPageSize 期望返回结果的数量, 如果 < 0 则一次返回所有结果
  162. * @param aCompletionBlock 完成的回调
  163. *
  164. *
  165. * \~english
  166. * Get public groups with the specified range from the server
  167. *
  168. * @param aCursor Cursor, input nil the first time
  169. * @param aPageSize Expect result count, return all results if count is less than zero
  170. * @param aCompletionBlock The callback block of completion
  171. *
  172. */
  173. - (void)getPublicGroupsFromServerWithCursor:(NSString *)aCursor
  174. pageSize:(NSInteger)aPageSize
  175. completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
  176. /*!
  177. * \~chinese
  178. * 根据群ID搜索公开群
  179. *
  180. * 同步方法,会阻塞当前线程
  181. *
  182. * @param aGroundId 群组id
  183. * @param pError 错误信息
  184. *
  185. * @return 搜索到的群组
  186. *
  187. * \~english
  188. * Search a public group with the id
  189. *
  190. * Synchronization method will block the current thread
  191. *
  192. * @param aGroundId Group id
  193. * @param pError Error
  194. *
  195. * @return The group with the id
  196. */
  197. - (EMGroup *)searchPublicGroupWithId:(NSString *)aGroundId
  198. error:(EMError **)pError;
  199. /*!
  200. * \~chinese
  201. * 根据群ID搜索公开群
  202. *
  203. * @param aGroundId 群组id
  204. * @param aCompletionBlock 完成的回调
  205. *
  206. *
  207. * \~english
  208. * Search public group with group id
  209. *
  210. * @param aGroundId Group id
  211. * @param aCompletionBlock The callback block of completion
  212. *
  213. */
  214. - (void)searchPublicGroupWithId:(NSString *)aGroundId
  215. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  216. #pragma mark - Create
  217. /*!
  218. * \~chinese
  219. * 创建群组
  220. *
  221. * 同步方法,会阻塞当前线程
  222. *
  223. * @param aSubject 群组名称
  224. * @param aDescription 群组描述
  225. * @param aInvitees 群组成员(不包括创建者自己)
  226. * @param aMessage 邀请消息
  227. * @param aSetting 群组属性
  228. * @param pError 出错信息
  229. *
  230. * @return 创建的群组
  231. *
  232. * \~english
  233. * Create a group
  234. *
  235. * Synchronization method will block the current thread
  236. *
  237. * @param aSubject Group subject
  238. * @param aDescription Group description
  239. * @param aInvitees Group members, without creater
  240. * @param aMessage Invitation message
  241. * @param aSetting Group options
  242. * @param pError Error
  243. *
  244. * @return Created group
  245. */
  246. - (EMGroup *)createGroupWithSubject:(NSString *)aSubject
  247. description:(NSString *)aDescription
  248. invitees:(NSArray *)aInvitees
  249. message:(NSString *)aMessage
  250. setting:(EMGroupOptions *)aSetting
  251. error:(EMError **)pError;
  252. /*!
  253. * \~chinese
  254. * 创建群组
  255. *
  256. * @param aSubject 群组名称
  257. * @param aDescription 群组描述
  258. * @param aInvitees 群组成员(不包括创建者自己)
  259. * @param aMessage 邀请消息
  260. * @param aSetting 群组属性
  261. * @param aCompletionBlock 完成的回调
  262. *
  263. *
  264. * \~english
  265. * Create a group
  266. *
  267. * @param aSubject Group subject
  268. * @param aDescription Group description
  269. * @param aInvitees Group members, without creater
  270. * @param aMessage Invitation message
  271. * @param aSetting Group options
  272. * @param aCompletionBlock The callback block of completion
  273. *
  274. */
  275. - (void)createGroupWithSubject:(NSString *)aSubject
  276. description:(NSString *)aDescription
  277. invitees:(NSArray *)aInvitees
  278. message:(NSString *)aMessage
  279. setting:(EMGroupOptions *)aSetting
  280. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  281. #pragma mark - Fetch Info
  282. /*!
  283. * \~chinese
  284. * 获取群组详情,包含群组ID,群组名称,群组描述,群组基本属性,群组Owner, 群组管理员
  285. *
  286. * 同步方法,会阻塞当前线程
  287. *
  288. * @param aGroupId 群组ID
  289. * @param pError 错误信息
  290. *
  291. * @return 群组
  292. *
  293. * \~english
  294. * Fetch group info,include ID, name, description,setting, owner, admins
  295. *
  296. * Synchronization method will block the current thread
  297. *
  298. * @param aGroupId Group id
  299. * @param pError Error
  300. *
  301. * @return Group instance
  302. */
  303. - (EMGroup *)getGroupSpecificationFromServerWithId:(NSString *)aGroupId
  304. error:(EMError **)pError;
  305. /*!
  306. * \~chinese
  307. * 获取群组详情,包含群组ID,群组名称,群组描述,群组基本属性,群组Owner, 群组管理员
  308. *
  309. * @param aGroupId 群组ID
  310. * @param aCompletionBlock 完成的回调
  311. *
  312. *
  313. * \~english
  314. * Fetch group specification, including: ID, name, description, setting, owner, admins
  315. *
  316. * @param aGroupId Group id
  317. * @param aCompletionBlock The callback block of completion
  318. *
  319. */
  320. - (void)getGroupSpecificationFromServerWithId:(NSString *)aGroupId
  321. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  322. /*!
  323. * \~chinese
  324. * 获取群组成员列表
  325. *
  326. * @param aGroupId 群组ID
  327. * @param aCursor 游标,,首次调用传空
  328. * @param aPageSize 获取多少条
  329. * @param pError 错误信息
  330. *
  331. * @return 列表和游标
  332. *
  333. * \~english
  334. * Get the list of group members from the server
  335. *
  336. * @param aGroupId Group id
  337. * @param aCursor Cursor, input nil the first time
  338. * @param aPageSize Page size
  339. * @param pError Error
  340. *
  341. * @return List and cursor
  342. *
  343. */
  344. - (EMCursorResult *)getGroupMemberListFromServerWithId:(NSString *)aGroupId
  345. cursor:(NSString *)aCursor
  346. pageSize:(NSInteger)aPageSize
  347. error:(EMError **)pError;
  348. /*!
  349. * \~chinese
  350. * 获取群组成员列表
  351. *
  352. * @param aGroupId 群组ID
  353. * @param aCursor 游标,首次调用传空
  354. * @param aPageSize 获取多少条
  355. * @param aCompletionBlock 完成的回调
  356. *
  357. *
  358. * \~english
  359. * Get the list of group members from the server
  360. *
  361. * @param aGroupId Group id
  362. * @param aCursor Cursor, input nil the first time
  363. * @param aPageSize Page size
  364. * @param aCompletionBlock The callback block of completion
  365. *
  366. */
  367. - (void)getGroupMemberListFromServerWithId:(NSString *)aGroupId
  368. cursor:(NSString *)aCursor
  369. pageSize:(NSInteger)aPageSize
  370. completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
  371. /*!
  372. * \~chinese
  373. * 获取群组黑名单列表, 需要owner/admin权限
  374. *
  375. * @param aGroupId 群组ID
  376. * @param aPageNum 获取第几页
  377. * @param aPageSize 获取多少条
  378. * @param pError 错误信息
  379. *
  380. *
  381. * \~english
  382. * Get the blacklist of group from the server, need owner / admin permissions
  383. *
  384. * @param aGroupId Group id
  385. * @param aPageNum Page number
  386. * @param aPageSize Page size
  387. * @param pError Error
  388. *
  389. */
  390. - (NSArray *)getGroupBlacklistFromServerWithId:(NSString *)aGroupId
  391. pageNumber:(NSInteger)aPageNum
  392. pageSize:(NSInteger)aPageSize
  393. error:(EMError **)pError;
  394. /*!
  395. * \~chinese
  396. * 获取群组黑名单列表, 需要owner/admin权限
  397. *
  398. * @param aGroupId 群组ID
  399. * @param aPageNum 获取第几页
  400. * @param aPageSize 获取多少条
  401. * @param aCompletionBlock 完成的回调
  402. *
  403. *
  404. * \~english
  405. * Get group's blacklist, need owner / admin permissions
  406. *
  407. * @param aGroupId Group id
  408. * @param aPageNum Page number
  409. * @param aPageSize Page size
  410. * @param aCompletionBlock The callback block of completion
  411. *
  412. */
  413. - (void)getGroupBlacklistFromServerWithId:(NSString *)aGroupId
  414. pageNumber:(NSInteger)aPageNum
  415. pageSize:(NSInteger)aPageSize
  416. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
  417. /*!
  418. * \~chinese
  419. * 获取群组被禁言列表
  420. *
  421. * @param aGroupId 群组ID
  422. * @param aPageNum 获取第几页
  423. * @param aPageSize 获取多少条
  424. * @param pError 错误信息
  425. *
  426. *
  427. * \~english
  428. * Get the mutes of group from the server
  429. *
  430. * @param aGroupId Group id
  431. * @param aPageNum Page number
  432. * @param aPageSize Page size
  433. * @param pError Error
  434. *
  435. */
  436. - (NSArray *)getGroupMuteListFromServerWithId:(NSString *)aGroupId
  437. pageNumber:(NSInteger)aPageNum
  438. pageSize:(NSInteger)aPageSize
  439. error:(EMError **)pError;
  440. /*!
  441. * \~chinese
  442. * 获取群组被禁言列表
  443. *
  444. * @param aGroupId 群组ID
  445. * @param aPageNum 获取第几页
  446. * @param aPageSize 获取多少条
  447. * @param aCompletionBlock 完成的回调
  448. *
  449. *
  450. * \~english
  451. * Get the mutes of group from the server
  452. *
  453. * @param aGroupId Group id
  454. * @param aPageNum Page number
  455. * @param aPageSize Page size
  456. * @param aCompletionBlock The callback block of completion
  457. *
  458. */
  459. - (void)getGroupMuteListFromServerWithId:(NSString *)aGroupId
  460. pageNumber:(NSInteger)aPageNum
  461. pageSize:(NSInteger)aPageSize
  462. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
  463. /*!
  464. * \~chinese
  465. * 获取群共享文件列表
  466. *
  467. * @param aGroupId 群组ID
  468. * @param aPageNum 获取第几页
  469. * @param aPageSize 获取多少条
  470. * @param pError 错误信息
  471. *
  472. * @result 群共享文件列表
  473. *
  474. * \~english
  475. * Get the share files of group from the server
  476. *
  477. * @param aGroupId Group id
  478. * @param aPageNum Page number
  479. * @param aPageSize Page size
  480. * @param pError error
  481. *
  482. * @result The share files of group
  483. */
  484. - (NSArray *)getGroupFileListWithId:(NSString *)aGroupId
  485. pageNumber:(NSInteger)aPageNum
  486. pageSize:(NSInteger)aPageSize
  487. error:(EMError **)pError;
  488. /*!
  489. * \~chinese
  490. * 获取群共享文件列表
  491. *
  492. * @param aGroupId 群组ID
  493. * @param aPageNum 获取第几页
  494. * @param aPageSize 获取多少条
  495. * @param aCompletionBlock 完成的回调
  496. *
  497. * \~english
  498. * Get the share files of group from the server
  499. *
  500. * @param aGroupId Group id
  501. * @param aPageNum Page number
  502. * @param aPageSize Page size
  503. * @param aCompletionBlock The callback block of completion
  504. */
  505. - (void)getGroupFileListWithId:(NSString *)aGroupId
  506. pageNumber:(NSInteger)aPageNum
  507. pageSize:(NSInteger)aPageSize
  508. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
  509. /*!
  510. * \~chinese
  511. * 获取群组白名单列表
  512. *
  513. * @param aGroupId 群组ID
  514. * @param pError 错误信息
  515. *
  516. *
  517. * \~english
  518. * Get the whitelist of group from the server
  519. *
  520. * @param aGroupId Group id
  521. * @param pError Error
  522. *
  523. */
  524. - (NSArray *)getGroupWhiteListFromServerWithId:(NSString *)aGroupId
  525. error:(EMError **)pError;
  526. /*!
  527. * \~chinese
  528. * 获取群组白名单列表
  529. *
  530. * @param aGroupId 群组ID
  531. * @param aCompletionBlock 完成的回调
  532. *
  533. *
  534. * \~english
  535. * Get the whitelist of group from the server
  536. *
  537. * @param aGroupId Group id
  538. * @param aCompletionBlock The callback block of completion
  539. *
  540. */
  541. - (void)getGroupWhiteListFromServerWithId:(NSString *)aGroupId
  542. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
  543. /*!
  544. * \~chinese
  545. * 查看自己是否在群组白名单中
  546. *
  547. * @param aGroupId 群组ID
  548. * @param pError 错误信息
  549. *
  550. *
  551. * \~english
  552. * Gets whether the member is on the whitelist
  553. *
  554. * @param aGroupId Group id
  555. * @param pError Error
  556. *
  557. */
  558. - (BOOL)isMemberInWhiteListFromServerWithGroupId:(NSString *)aGroupId
  559. error:(EMError **)pError;
  560. /*!
  561. * \~chinese
  562. * 查看自己是否在群组白名单中
  563. *
  564. * @param aGroupId 群组ID
  565. * @param aCompletionBlock 完成的回调
  566. *
  567. *
  568. * \~english
  569. * Gets whether the member is on the whitelist
  570. *
  571. * @param aGroupId Group id
  572. * @param aCompletionBlock The callback block of completion
  573. *
  574. */
  575. - (void)isMemberInWhiteListFromServerWithGroupId:(NSString *)aGroupId
  576. completion:(void (^)(BOOL inWhiteList, EMError *aError))aCompletionBlock;
  577. /*!
  578. * \~chinese
  579. * 获取群公告
  580. *
  581. * @param aGroupId 群组ID
  582. * @param pError 错误信息
  583. *
  584. * @result 群声明, 失败返回nil
  585. *
  586. * \~english
  587. * Get the announcement of group from the server
  588. *
  589. * @param aGroupId Group id
  590. * @param pError error
  591. *
  592. * @result Group Announcement, return nil if fail
  593. */
  594. - (NSString *)getGroupAnnouncementWithId:(NSString *)aGroupId
  595. error:(EMError **)pError;
  596. /*!
  597. * \~chinese
  598. * 获取群公告
  599. *
  600. * @param aGroupId 群组ID
  601. * @param aCompletionBlock 完成的回调
  602. *
  603. *
  604. * \~english
  605. * Get the announcement of group from the server
  606. *
  607. * @param aGroupId Group id
  608. * @param aCompletionBlock The callback block of completion
  609. *
  610. */
  611. - (void)getGroupAnnouncementWithId:(NSString *)aGroupId
  612. completion:(void (^)(NSString *aAnnouncement, EMError *aError))aCompletionBlock;
  613. #pragma mark - Edit Group
  614. /*!
  615. * \~chinese
  616. * 邀请用户加入群组
  617. *
  618. * 同步方法,会阻塞当前线程
  619. *
  620. * @param aOccupants 被邀请的用户名列表
  621. * @param aGroupId 群组ID
  622. * @param aWelcomeMessage 欢迎信息
  623. * @param pError 错误信息
  624. *
  625. * @result 群组实例, 失败返回nil
  626. *
  627. * \~english
  628. * Invite User to join a group
  629. *
  630. * Synchronization method will block the current thread
  631. *
  632. * @param aOccupants Invited users
  633. * @param aGroupId Group id
  634. * @param aWelcomeMessage Welcome message
  635. * @param pError Error
  636. *
  637. * @result Group instance, return nil if fail
  638. */
  639. - (EMGroup *)addOccupants:(NSArray *)aOccupants
  640. toGroup:(NSString *)aGroupId
  641. welcomeMessage:(NSString *)aWelcomeMessage
  642. error:(EMError **)pError;
  643. /*!
  644. * \~chinese
  645. * 邀请用户加入群组
  646. *
  647. * @param aUsers 被邀请的用户名列表
  648. * @param aGroupId 群组ID
  649. * @param aMessage 欢迎信息
  650. * @param aCompletionBlock 完成的回调
  651. *
  652. *
  653. * \~english
  654. * Invite User to join a group
  655. *
  656. * @param aUsers Invited users
  657. * @param aGroupId Group id
  658. * @param aMessage Welcome message
  659. * @param aCompletionBlock The callback block of completion
  660. *
  661. */
  662. - (void)addMembers:(NSArray *)aUsers
  663. toGroup:(NSString *)aGroupId
  664. message:(NSString *)aMessage
  665. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  666. /*!
  667. * \~chinese
  668. * 将群成员移出群组, 需要owner权限
  669. *
  670. * 同步方法,会阻塞当前线程
  671. *
  672. * @param aOccupants 要移出群组的用户列表
  673. * @param aGroupId 群组ID
  674. * @param pError 错误信息
  675. *
  676. * @result 群组实例
  677. *
  678. * \~english
  679. * Remove members from a group, required owner‘s authority
  680. *
  681. * Synchronization method will block the current thread
  682. *
  683. * @param aOccupants Users to be removed
  684. * @param aGroupId Group id
  685. * @param pError Error
  686. *
  687. * @result Group instance
  688. */
  689. - (EMGroup *)removeOccupants:(NSArray *)aOccupants
  690. fromGroup:(NSString *)aGroupId
  691. error:(EMError **)pError;
  692. /*!
  693. * \~chinese
  694. * 将群成员移出群组, 需要owner权限
  695. *
  696. * @param aUsers 要移出群组的用户列表
  697. * @param aGroupId 群组ID
  698. * @param aCompletionBlock 完成的回调
  699. *
  700. *
  701. * \~english
  702. * Remove members from a group, owner‘s authority is required
  703. *
  704. * @param aUsers Users to be removed
  705. * @param aGroupId Group id
  706. * @param aCompletionBlock The callback block of completion
  707. *
  708. */
  709. - (void)removeMembers:(NSArray *)aUsers
  710. fromGroup:(NSString *)aGroupId
  711. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  712. /*!
  713. * \~chinese
  714. * 加人到群组黑名单, 需要owner权限
  715. *
  716. * 同步方法,会阻塞当前线程
  717. *
  718. * @param aOccupants 要加入黑名单的用户
  719. * @param aGroupId 群组ID
  720. * @param pError 错误信息
  721. *
  722. * @result 群组实例
  723. *
  724. * \~english
  725. * Add users to group blacklist, required owner‘s authority
  726. *
  727. * Synchronization method will block the current thread
  728. *
  729. * @param aOccupants Users to be added
  730. * @param aGroupId Group id
  731. * @param pError Error
  732. *
  733. * @result Group instance
  734. */
  735. - (EMGroup *)blockOccupants:(NSArray *)aOccupants
  736. fromGroup:(NSString *)aGroupId
  737. error:(EMError **)pError;
  738. /*!
  739. * \~chinese
  740. * 加人到群组黑名单, 需要owner权限
  741. *
  742. * @param aMembers 要加入黑名单的用户
  743. * @param aGroupId 群组ID
  744. * @param aCompletionBlock 完成的回调
  745. *
  746. *
  747. * \~english
  748. * Add users to group blacklist, owner‘s authority is required
  749. *
  750. * @param aMembers Users to be added
  751. * @param aGroupId Group id
  752. * @param aCompletionBlock The callback block of completion
  753. *
  754. */
  755. - (void)blockMembers:(NSArray *)aMembers
  756. fromGroup:(NSString *)aGroupId
  757. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  758. /*!
  759. * \~chinese
  760. * 从群组黑名单中减人, 需要owner权限
  761. *
  762. * 同步方法,会阻塞当前线程
  763. *
  764. * @param aOccupants 要从黑名单中移除的用户名列表
  765. * @param aGroupId 群组ID
  766. * @param pError 错误信息
  767. *
  768. * @result 群组对象
  769. *
  770. * \~english
  771. * Remove users from group blacklist, required owner‘s authority
  772. *
  773. * Synchronization method will block the current thread
  774. *
  775. * @param aOccupants Users to be removed
  776. * @param aGroupId Group id
  777. * @param pError Error
  778. *
  779. * @result Group instance
  780. */
  781. - (EMGroup *)unblockOccupants:(NSArray *)aOccupants
  782. forGroup:(NSString *)aGroupId
  783. error:(EMError **)pError;
  784. /*!
  785. * \~chinese
  786. * 从群组黑名单中减人, 需要owner权限
  787. *
  788. * @param aMembers 要从黑名单中移除的用户名列表
  789. * @param aGroupId 群组ID
  790. * @param aCompletionBlock 完成的回调
  791. *
  792. *
  793. * \~english
  794. * Remove users out of group blacklist, owner‘s authority is required
  795. *
  796. * @param aMembers Users to be removed
  797. * @param aGroupId Group id
  798. * @param aCompletionBlock The callback block of completion
  799. *
  800. */
  801. - (void)unblockMembers:(NSArray *)aMembers
  802. fromGroup:(NSString *)aGroupId
  803. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  804. /*!
  805. * \~chinese
  806. * 更改群组主题, 需要owner权限
  807. *
  808. * 同步方法,会阻塞当前线程
  809. *
  810. * @param aSubject 新主题
  811. * @param aGroupId 群组ID
  812. * @param pError 错误信息
  813. *
  814. * @result 群组对象
  815. *
  816. * \~english
  817. * Change group subject, owner‘s authority is required
  818. *
  819. * Synchronization method will block the current thread
  820. *
  821. * @param aSubject New group subject
  822. * @param aGroupId Group id
  823. * @param pError Error
  824. *
  825. * @result Group instance
  826. */
  827. - (EMGroup *)changeGroupSubject:(NSString *)aSubject
  828. forGroup:(NSString *)aGroupId
  829. error:(EMError **)pError;
  830. /*!
  831. * \~chinese
  832. * 更改群组主题, 需要owner权限
  833. *
  834. * @param aSubject 新主题
  835. * @param aGroupId 群组ID
  836. * @param aCompletionBlock 完成的回调
  837. *
  838. *
  839. * \~english
  840. * Change the group subject, owner‘s authority is required
  841. *
  842. * @param aSubject New group‘s subject
  843. * @param aGroupId Group id
  844. * @param aCompletionBlock The callback block of completion
  845. *
  846. */
  847. - (void)updateGroupSubject:(NSString *)aSubject
  848. forGroup:(NSString *)aGroupId
  849. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  850. /*!
  851. * \~chinese
  852. * 更改群组说明信息, 需要owner权限
  853. *
  854. * 同步方法,会阻塞当前线程
  855. *
  856. * @param aDescription 说明信息
  857. * @param aGroupId 群组ID
  858. * @param pError 错误信息
  859. *
  860. * @result 群组对象
  861. *
  862. * \~english
  863. * Change group description, owner‘s authority is required
  864. *
  865. * Synchronization method will block the current thread
  866. *
  867. * @param aDescription New group description
  868. * @param aGroupId Group id
  869. * @param pError Error
  870. *
  871. * @result Group
  872. */
  873. - (EMGroup *)changeDescription:(NSString *)aDescription
  874. forGroup:(NSString *)aGroupId
  875. error:(EMError **)pError;
  876. /*!
  877. * \~chinese
  878. * 更改群组说明信息, 需要owner权限
  879. *
  880. * @param aDescription 说明信息
  881. * @param aGroupId 群组ID
  882. * @param aCompletionBlock 完成的回调
  883. *
  884. *
  885. * \~english
  886. * Change the group description, owner‘s authority is required
  887. *
  888. * @param aDescription New group‘s description
  889. * @param aGroupId Group id
  890. * @param aCompletionBlock The callback block of completion
  891. *
  892. */
  893. - (void)updateDescription:(NSString *)aDescription
  894. forGroup:(NSString *)aGroupId
  895. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  896. /*!
  897. * \~chinese
  898. * 退出群组,owner不能退出群,只能销毁群
  899. *
  900. * 同步方法,会阻塞当前线程
  901. *
  902. * @param aGroupId 群组ID
  903. * @param pError 错误信息
  904. *
  905. *
  906. * \~english
  907. * Leave a group, owner can't leave the group, can only destroy the group
  908. *
  909. * Synchronization method will block the current thread
  910. *
  911. * @param aGroupId Group id
  912. * @param pError Error
  913. *
  914. */
  915. - (void)leaveGroup:(NSString *)aGroupId
  916. error:(EMError **)pError;
  917. /*!
  918. * \~chinese
  919. * 退出群组,owner不能退出群,只能销毁群
  920. *
  921. * @param aGroupId 群组ID
  922. * @param aCompletionBlock 完成的回调
  923. *
  924. *
  925. * \~english
  926. * Leave a group, owner can't leave the group, can only destroy the group
  927. *
  928. * @param aGroupId Group id
  929. * @param aCompletionBlock The callback block of completion
  930. *
  931. */
  932. - (void)leaveGroup:(NSString *)aGroupId
  933. completion:(void (^)(EMError *aError))aCompletionBlock;
  934. /*!
  935. * \~chinese
  936. * 解散群组, 需要owner权限
  937. *
  938. * 同步方法,会阻塞当前线程
  939. *
  940. * @param aGroupId 群组ID
  941. *
  942. * @result 错误信息, 成功返回nil
  943. *
  944. * \~english
  945. * Destroy a group, owner‘s authority is required
  946. *
  947. * Synchronization method will block the current thread
  948. *
  949. * @param aGroupId Group id
  950. *
  951. * @result Error, return nil if success
  952. */
  953. - (EMError *)destroyGroup:(NSString *)aGroupId;
  954. /*!
  955. * \~chinese
  956. * 解散群组, 需要owner权限
  957. *
  958. * @param aGroupId 群组ID
  959. * @param aCompletionBlock 完成的回调
  960. *
  961. * \~english
  962. * Destroy a group, owner‘s authority is required
  963. *
  964. * @param aGroupId Group id
  965. * @param aCompletionBlock The callback block of completion
  966. *
  967. */
  968. - (void)destroyGroup:(NSString *)aGroupId
  969. finishCompletion:(void (^)(EMError *aError))aCompletionBlock;
  970. /*!
  971. * \~chinese
  972. * 屏蔽群消息,服务器不再发送此群的消息给用户,owner不能屏蔽群消息
  973. *
  974. * 同步方法,会阻塞当前线程
  975. *
  976. * @param aGroupId 要屏蔽的群ID
  977. * @param pError 错误信息
  978. *
  979. * @result 群组实例
  980. *
  981. * \~english
  982. * Block group messages, server will blocks the messages from the group, owner can't block the group's message
  983. *
  984. * Synchronization method will block the current thread
  985. *
  986. * @param aGroupId Group id
  987. * @param pError Error
  988. *
  989. * @result Group instance
  990. */
  991. - (EMGroup *)blockGroup:(NSString *)aGroupId
  992. error:(EMError **)pError;
  993. /*!
  994. * \~chinese
  995. * 屏蔽群消息,服务器不再发送此群的消息给用户,owner不能屏蔽群消息
  996. *
  997. * @param aGroupId 要屏蔽的群ID
  998. * @param aCompletionBlock 完成的回调
  999. *
  1000. * \~english
  1001. * Block group messages, server blocks the messages from the group, owner can't block the group's messages
  1002. *
  1003. * @param aGroupId Group id
  1004. * @param aCompletionBlock The callback block of completion
  1005. *
  1006. */
  1007. - (void)blockGroup:(NSString *)aGroupId
  1008. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1009. /*!
  1010. * \~chinese
  1011. * 取消屏蔽群消息
  1012. *
  1013. * 同步方法,会阻塞当前线程
  1014. *
  1015. * @param aGroupId 要取消屏蔽的群ID
  1016. * @param pError 错误信息
  1017. *
  1018. * @result 返回群组实例
  1019. *
  1020. * \~english
  1021. * Unblock group messages
  1022. *
  1023. * Synchronization method will block the current thread
  1024. *
  1025. * @param aGroupId Group id
  1026. * @param pError Error
  1027. *
  1028. * @result Group instance
  1029. */
  1030. - (EMGroup *)unblockGroup:(NSString *)aGroupId
  1031. error:(EMError **)pError;
  1032. /*!
  1033. * \~chinese
  1034. * 取消屏蔽群消息
  1035. *
  1036. * @param aGroupId 要取消屏蔽的群ID
  1037. * @param aCompletionBlock 完成的回调
  1038. *
  1039. * \~english
  1040. * Unblock group message
  1041. *
  1042. * @param aGroupId Group id
  1043. * @param aCompletionBlock The callback block of completion
  1044. *
  1045. */
  1046. - (void)unblockGroup:(NSString *)aGroupId
  1047. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1048. /*!
  1049. * \~chinese
  1050. * 改变群主,需要Owner权限
  1051. *
  1052. * 同步方法,会阻塞当前线程
  1053. *
  1054. * @param aGroupId 群ID
  1055. * @param aNewOwner 新群主
  1056. * @param pError 错误信息
  1057. *
  1058. * @result 返回群组实例
  1059. *
  1060. * \~english
  1061. * Change group owner, need Owner permissions
  1062. *
  1063. * Synchronization method will block the current thread
  1064. *
  1065. * @param aGroupId Group id
  1066. * @param aNewOwner New group owner
  1067. * @param pError Error
  1068. *
  1069. * @result Group instance
  1070. */
  1071. - (EMGroup *)updateGroupOwner:(NSString *)aGroupId
  1072. newOwner:(NSString *)aNewOwner
  1073. error:(EMError **)pError;
  1074. /*!
  1075. * \~chinese
  1076. * 改变群主,需要Owner权限
  1077. *
  1078. * @param aGroupId 群ID
  1079. * @param aNewOwner 新群主
  1080. * @param aCompletionBlock 完成的回调
  1081. *
  1082. *
  1083. * \~english
  1084. * Change group owner, need Owner permissions
  1085. *
  1086. * @param aGroupId Group id
  1087. * @param aNewOwner New group owner
  1088. * @param aCompletionBlock The callback block of completion
  1089. *
  1090. */
  1091. - (void)updateGroupOwner:(NSString *)aGroupId
  1092. newOwner:(NSString *)aNewOwner
  1093. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1094. /*!
  1095. * \~chinese
  1096. * 添加群组管理员,需要Owner权限
  1097. *
  1098. * 同步方法,会阻塞当前线程
  1099. *
  1100. * @param aAdmin 要添加的群组管理员
  1101. * @param aGroupId 群ID
  1102. * @param pError 错误信息
  1103. * @result 返回群组实例
  1104. *
  1105. * \~english
  1106. * Add group admin, need Owner permissions
  1107. *
  1108. * Synchronization method will block the current thread
  1109. *
  1110. * @param aAdmin Admin
  1111. * @param aGroupId Group id
  1112. * @param pError Error
  1113. * @result Group instance
  1114. */
  1115. - (EMGroup *)addAdmin:(NSString *)aAdmin
  1116. toGroup:(NSString *)aGroupId
  1117. error:(EMError **)pError;
  1118. /*!
  1119. * \~chinese
  1120. * 添加群组管理员,需要Owner权限
  1121. *
  1122. * @param aAdmin 要添加的群组管理员
  1123. * @param aGroupId 群ID
  1124. * @param aCompletionBlock 完成的回调
  1125. *
  1126. *
  1127. * \~english
  1128. * Add group admin, need Owner permissions
  1129. *
  1130. * @param aAdmin Admin
  1131. * @param aGroupId Group id
  1132. * @param aCompletionBlock The callback block of completion
  1133. *
  1134. */
  1135. - (void)addAdmin:(NSString *)aAdmin
  1136. toGroup:(NSString *)aGroupId
  1137. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1138. /*!
  1139. * \~chinese
  1140. * 移除群组管理员,需要Owner权限
  1141. *
  1142. * 同步方法,会阻塞当前线程
  1143. *
  1144. * @param aAdmin 要移除的群组管理员
  1145. * @param aGroupId 群ID
  1146. * @param pError 错误信息
  1147. *
  1148. * @result 返回群组实例
  1149. *
  1150. * \~english
  1151. * Remove group admin, need Owner permissions
  1152. *
  1153. * Synchronization method will block the current thread
  1154. *
  1155. * @param aAdmin Admin
  1156. * @param aGroupId Group id
  1157. * @param pError Error
  1158. *
  1159. * @result Group instance
  1160. */
  1161. - (EMGroup *)removeAdmin:(NSString *)aAdmin
  1162. fromGroup:(NSString *)aGroupId
  1163. error:(EMError **)pError;
  1164. /*!
  1165. * \~chinese
  1166. * 移除群组管理员,需要Owner权限
  1167. *
  1168. * @param aAdmin 要移除的群组管理员
  1169. * @param aGroupId 群ID
  1170. * @param aCompletionBlock 完成的回调
  1171. *
  1172. *
  1173. * \~english
  1174. * Remove group admin, need Owner permissions
  1175. *
  1176. * @param aAdmin Admin
  1177. * @param aGroupId Group id
  1178. * @param aCompletionBlock The callback block of completion
  1179. *
  1180. */
  1181. - (void)removeAdmin:(NSString *)aAdmin
  1182. fromGroup:(NSString *)aGroupId
  1183. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1184. /*!
  1185. * \~chinese
  1186. * 将一组成员禁言,需要Owner / Admin权限
  1187. *
  1188. * 同步方法,会阻塞当前线程
  1189. *
  1190. * @param aMuteMembers 要禁言的成员列表<NSString>
  1191. * @param aMuteMilliseconds 禁言时长
  1192. * @param aGroupId 群ID
  1193. * @param pError 错误信息
  1194. *
  1195. * @result 返回群组实例
  1196. *
  1197. * \~english
  1198. * Mute group members, need Owner / Admin permissions
  1199. *
  1200. * Synchronization method will block the current thread
  1201. *
  1202. * @param aMuteMembers The list of mute, type is <NSString>
  1203. * @param aMuteMilliseconds Muted time duration in millisecond
  1204. * @param aGroupId Group id
  1205. * @param pError Error
  1206. *
  1207. * @result Group instance
  1208. */
  1209. - (EMGroup *)muteMembers:(NSArray *)aMuteMembers
  1210. muteMilliseconds:(NSInteger)aMuteMilliseconds
  1211. fromGroup:(NSString *)aGroupId
  1212. error:(EMError **)pError;
  1213. /*!
  1214. * \~chinese
  1215. * 将一组成员禁言,需要Owner / Admin权限
  1216. *
  1217. * @param aMuteMembers 要禁言的成员列表<NSString>
  1218. * @param aMuteMilliseconds 禁言时长
  1219. * @param aGroupId 群ID
  1220. * @param aCompletionBlock 完成的回调
  1221. *
  1222. * \~english
  1223. * Mute group members, need Owner / Admin permissions
  1224. *
  1225. * Synchronization method will block the current thread
  1226. *
  1227. * @param aMuteMembers The list of mute, type is <NSString>
  1228. * @param aMuteMilliseconds Muted time duration in millisecond
  1229. * @param aGroupId Group id
  1230. * @param aCompletionBlock The callback block of completion
  1231. *
  1232. */
  1233. - (void)muteMembers:(NSArray *)aMuteMembers
  1234. muteMilliseconds:(NSInteger)aMuteMilliseconds
  1235. fromGroup:(NSString *)aGroupId
  1236. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1237. /*!
  1238. * \~chinese
  1239. * 解除禁言,需要Owner / Admin权限
  1240. *
  1241. * 同步方法,会阻塞当前线程
  1242. *
  1243. * @param aMuteMembers 被解除的列表<NSString>
  1244. * @param aGroupId 群ID
  1245. * @param pError 错误信息
  1246. *
  1247. * @result 返回群组实例
  1248. *
  1249. * \~english
  1250. * Unmute group members, need Owner / Admin permissions
  1251. *
  1252. * Synchronization method will block the current thread
  1253. *
  1254. * @param aMembers The list of unmute, type is <NSString>
  1255. * @param aGroupId Group id
  1256. * @param pError Error
  1257. *
  1258. * @result Group instance
  1259. */
  1260. - (EMGroup *)unmuteMembers:(NSArray *)aMembers
  1261. fromGroup:(NSString *)aGroupId
  1262. error:(EMError **)pError;
  1263. /*!
  1264. * \~chinese
  1265. * 解除禁言,需要Owner / Admin权限
  1266. *
  1267. * @param aMuteMembers 被解除的列表<NSString>
  1268. * @param aGroupId 群ID
  1269. * @param aCompletionBlock 完成的回调
  1270. *
  1271. * \~english
  1272. * Unmute group members, need Owner / Admin permissions
  1273. *
  1274. * @param aMembers The list of unmute, type is <NSString>
  1275. * @param aGroupId Group id
  1276. * @param aCompletionBlock The callback block of completion
  1277. *
  1278. */
  1279. - (void)unmuteMembers:(NSArray *)aMembers
  1280. fromGroup:(NSString *)aGroupId
  1281. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1282. /*!
  1283. * \~chinese
  1284. * 设置全员禁言,需要Owner / Admin权限
  1285. *
  1286. * 同步方法,会阻塞当前线程
  1287. *
  1288. * @param aGroupId 群组ID
  1289. * @param pError 错误信息
  1290. *
  1291. * @result 群组实例
  1292. *
  1293. * \~english
  1294. * mute all members, need Owner / Admin permissions
  1295. *
  1296. * Synchronization method will block the current thread
  1297. *
  1298. * @param aGroupId Group id
  1299. * @param pError Error
  1300. *
  1301. * @result Group instance
  1302. */
  1303. - (EMGroup *)muteAllMembersFromGroup:(NSString *)aGroupId
  1304. error:(EMError **)pError;
  1305. /*!
  1306. * \~chinese
  1307. * 设置全员禁言,需要Owner / Admin权限
  1308. *
  1309. * @param aGroupId 群组ID
  1310. * @param aCompletionBlock 完成的回调
  1311. *
  1312. * \~english
  1313. * mute all members, need Owner / Admin permissions
  1314. *
  1315. * @param aGroupId Group id
  1316. * @param aCompletionBlock The callback block of completion
  1317. *
  1318. */
  1319. - (void)muteAllMembersFromGroup:(NSString *)aGroupId
  1320. completion:(void(^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1321. /*!
  1322. * \~chinese
  1323. * 解除全员禁言,需要Owner / Admin权限
  1324. *
  1325. * 同步方法,会阻塞当前线程
  1326. *
  1327. * @param aGroupId 群组ID
  1328. * @param pError 错误信息
  1329. *
  1330. * @result 群组实例
  1331. *
  1332. * \~english
  1333. * unmute all members, need Owner / Admin permissions
  1334. *
  1335. * Synchronization method will block the current thread
  1336. *
  1337. * @param aGroupId Group id
  1338. * @param pError Error
  1339. *
  1340. * @result Group instance
  1341. */
  1342. - (EMGroup *)unmuteAllMembersFromGroup:(NSString *)aGroupId
  1343. error:(EMError **)pError;
  1344. /*!
  1345. * \~chinese
  1346. * 解除全员禁言,需要Owner / Admin权限
  1347. *
  1348. * @param aGroupId 群组ID
  1349. * @param aCompletionBlock 完成的回调
  1350. *
  1351. * \~english
  1352. * unmute all members, need Owner / Admin permissions
  1353. *
  1354. * @param aGroupId Group id
  1355. * @param aCompletionBlock The callback block of completion
  1356. *
  1357. */
  1358. - (void)unmuteAllMembersFromGroup:(NSString *)aGroupId
  1359. completion:(void(^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1360. /*!
  1361. * \~chinese
  1362. * 添加白名单,需要Owner / Admin权限
  1363. *
  1364. * 同步方法,会阻塞当前线程
  1365. *
  1366. * @param aMuteMembers 被添加的列表<NSString>
  1367. * @param aGroupId 群组ID
  1368. * @param pError 错误信息
  1369. *
  1370. * @result 聊天室实例
  1371. *
  1372. * \~english
  1373. * add white list members, need Owner / Admin permissions
  1374. *
  1375. * Synchronization method will block the current thread
  1376. *
  1377. * @param aMembers The list of whitelist, type is <NSString>
  1378. * @param aGroupId Group id
  1379. * @param pError Error
  1380. *
  1381. * @result Group instance
  1382. */
  1383. - (EMGroup *)addWhiteListMembers:(NSArray *)aMembers
  1384. fromGroup:(NSString *)aGroupId
  1385. error:(EMError **)pError;
  1386. /*!
  1387. * \~chinese
  1388. * 添加白名单,需要Owner / Admin权限
  1389. *
  1390. * @param aMembers 被添加的列表<NSString>
  1391. * @param aGroupId 群组ID
  1392. * @param aCompletionBlock 完成的回调
  1393. *
  1394. * \~english
  1395. * add white list members, need Owner / Admin permissions
  1396. *
  1397. * @param aMembers The list of whitelist, type is <NSString>
  1398. * @param aGroupId Group id
  1399. * @param aCompletionBlock The callback block of completion
  1400. *
  1401. */
  1402. - (void)addWhiteListMembers:(NSArray *)aMembers
  1403. fromGroup:(NSString *)aGroupId
  1404. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1405. /*!
  1406. * \~chinese
  1407. * 上传群共享文件
  1408. *
  1409. * @param aGroupId 群ID
  1410. * @param aFilePath 文件路径
  1411. * @param pError 错误信息
  1412. *
  1413. * @result 群实例
  1414. *
  1415. * \~english
  1416. * Upload the share file of group
  1417. *
  1418. * @param aGroupId Group id
  1419. * @param aFilePath Path of file
  1420. * @param pError error
  1421. *
  1422. * @result Group instance
  1423. */
  1424. - (void)uploadGroupSharedFileWithId:(NSString *)aGroupId
  1425. filePath:(NSString*)aFilePath
  1426. progress:(void (^)(int progress))aProgressBlock
  1427. completion:(void (^)(EMGroupSharedFile *aSharedFile, EMError *aError))aCompletionBlock;
  1428. /*!
  1429. * \~chinese
  1430. * 下载群共享文件
  1431. *
  1432. * @param aGroupId 群ID
  1433. * @param aFilePath 文件路径
  1434. * @param aSharedFileId 共享文件ID
  1435. * @param aProgressBlock 文件下载进度回调block
  1436. * @param aCompletionBlock 完成回调block
  1437. *
  1438. * \~english
  1439. * Download the share file of group
  1440. *
  1441. * @param aGroupId Group id
  1442. * @param aFilePath Path of file
  1443. * @param aSharedFileId share file id
  1444. * @param aProgressBlock The block of attachment upload progress
  1445. * @param aCompletionBlock The callback block of completion
  1446. */
  1447. - (void)downloadGroupSharedFileWithId:(NSString *)aGroupId
  1448. filePath:(NSString *)aFilePath
  1449. sharedFileId:(NSString *)aSharedFileId
  1450. progress:(void (^)(int progress))aProgressBlock
  1451. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1452. /*!
  1453. * \~chinese
  1454. * 删除群共享文件
  1455. *
  1456. * @param aGroupId 群ID
  1457. * @param aSharedFileId 共享文件ID
  1458. * @param pError 错误信息
  1459. *
  1460. * @result 群实例
  1461. *
  1462. * \~english
  1463. * Remove the share file of group
  1464. *
  1465. * Synchronization method will block the current thread
  1466. *
  1467. * @param aGroupId Group id
  1468. * @param aSharedFileId share file Id
  1469. * @param pError error
  1470. *
  1471. * @result Group instance
  1472. */
  1473. - (EMGroup *)removeGroupSharedFileWithId:(NSString *)aGroupId
  1474. sharedFileId:(NSString *)aSharedFileId
  1475. error:(EMError **)pError;
  1476. /*!
  1477. * \~chinese
  1478. * 删除群共享文件
  1479. *
  1480. * @param aGroupId 群ID
  1481. * @param aSharedFileId 共享文件ID
  1482. * @param aCompletionBlock 完成的回调
  1483. *
  1484. * \~english
  1485. * Remove the share file of group
  1486. *
  1487. * @param aGroupId Group id
  1488. * @param aSharedFileId share file Id
  1489. * @param aCompletionBlock The callback block of completion
  1490. */
  1491. - (void)removeGroupSharedFileWithId:(NSString *)aGroupId
  1492. sharedFileId:(NSString *)aSharedFileId
  1493. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1494. /*!
  1495. * \~chinese
  1496. * 修改群公告,需要Owner / Admin权限
  1497. *
  1498. * @param aGroupId 群ID
  1499. * @param aAnnouncement 群公告
  1500. * @param pError 错误信息
  1501. *
  1502. * @result 群实例
  1503. *
  1504. * \~english
  1505. * Update the announcement of group, need Owner / Admin permissions
  1506. *
  1507. * Synchronization method will block the current thread
  1508. *
  1509. * @param aGroupId Group id
  1510. * @param aAnnouncement announcement of group
  1511. * @param pError error
  1512. *
  1513. * @result Group instance
  1514. */
  1515. - (EMGroup *)updateGroupAnnouncementWithId:(NSString *)aGroupId
  1516. announcement:(NSString *)aAnnouncement
  1517. error:(EMError **)pError;
  1518. /*!
  1519. * \~chinese
  1520. * 修改群公告,需要Owner / Admin权限
  1521. *
  1522. * @param aGroupId 群ID
  1523. * @param aAnnouncement 群公告
  1524. * @param aCompletionBlock 完成的回调
  1525. *
  1526. * \~english
  1527. * Update the announcement of group, need Owner / Admin permissions
  1528. *
  1529. * @param aGroupId Group id
  1530. * @param aAnnouncement announcement of group
  1531. * @param aCompletionBlock The callback block of completion
  1532. *
  1533. */
  1534. - (void)updateGroupAnnouncementWithId:(NSString *)aGroupId
  1535. announcement:(NSString *)aAnnouncement
  1536. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1537. /*!
  1538. * \~chinese
  1539. * 修改群扩展信息,需要Owner权限
  1540. *
  1541. * @param aGroupId 群ID
  1542. * @param aExt 扩展信息
  1543. * @param pError 错误信息
  1544. *
  1545. * @result 群实例
  1546. *
  1547. * \~english
  1548. * Update the extended of the group, need Owner
  1549. *
  1550. * Synchronization method will block the current thread
  1551. *
  1552. * @param aGroupId Group id
  1553. * @param aExt Extended of the group
  1554. * @param pError error
  1555. *
  1556. * @result Group instance
  1557. */
  1558. - (EMGroup *)updateGroupExtWithId:(NSString *)aGroupId
  1559. ext:(NSString *)aExt
  1560. error:(EMError **)pError;
  1561. /*!
  1562. * \~chinese
  1563. * 修改群扩展信息,需要Owner权限
  1564. *
  1565. * @param aGroupId 群ID
  1566. * @param aExt 扩展信息
  1567. * @param aCompletionBlock 完成的回调
  1568. *
  1569. * \~english
  1570. * Update the extended of the group, need Owner
  1571. *
  1572. * @param aGroupId Group id
  1573. * @param aExt Extended of the group
  1574. * @param aCompletionBlock The callback block of completion
  1575. *
  1576. */
  1577. - (void)updateGroupExtWithId:(NSString *)aGroupId
  1578. ext:(NSString *)aExt
  1579. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1580. #pragma mark - Edit Public Group
  1581. /*!
  1582. * \~chinese
  1583. * 加入一个公开群组,群类型应该是EMGroupStylePublicOpenJoin
  1584. *
  1585. * 同步方法,会阻塞当前线程
  1586. *
  1587. * @param aGroupId 公开群组的ID
  1588. * @param pError 错误信息
  1589. *
  1590. * @result 所加入的公开群组
  1591. *
  1592. * \~english
  1593. * Join a public group, group style should be EMGroupStylePublicOpenJoin
  1594. *
  1595. * Synchronization method will block the current thread
  1596. *
  1597. * @param aGroupId Public group id
  1598. * @param pError Error
  1599. *
  1600. * @result Joined public group
  1601. */
  1602. - (EMGroup *)joinPublicGroup:(NSString *)aGroupId
  1603. error:(EMError **)pError;
  1604. /*!
  1605. * \~chinese
  1606. * 加入一个公开群组,群类型应该是EMGroupStylePublicOpenJoin
  1607. *
  1608. * @param aGroupId 公开群组的ID
  1609. * @param aCompletionBlock 完成的回调
  1610. *
  1611. * \~english
  1612. * Join a public group, group style should be EMGroupStylePublicOpenJoin
  1613. *
  1614. * @param aGroupId Public group id
  1615. * @param aCompletionBlock The callback block of completion
  1616. *
  1617. */
  1618. - (void)joinPublicGroup:(NSString *)aGroupId
  1619. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1620. /*!
  1621. * \~chinese
  1622. * 申请加入一个需批准的公开群组,群类型应该是EMGroupStylePublicJoinNeedApproval
  1623. *
  1624. * 同步方法,会阻塞当前线程
  1625. *
  1626. * @param aGroupId 公开群组的ID
  1627. * @param aMessage 请求加入的信息
  1628. * @param pError 错误信息
  1629. *
  1630. * @result 申请加入的公开群组
  1631. *
  1632. * \~english
  1633. * Request to join a public group, group style should be EMGroupStylePublicJoinNeedApproval
  1634. *
  1635. * Synchronization method will block the current thread
  1636. *
  1637. * @param aGroupId Public group id
  1638. * @param aMessage Request info
  1639. * @param pError Error
  1640. *
  1641. * @result Group instance
  1642. */
  1643. - (EMGroup *)applyJoinPublicGroup:(NSString *)aGroupId
  1644. message:(NSString *)aMessage
  1645. error:(EMError **)pError;
  1646. /*!
  1647. * \~chinese
  1648. * 申请加入一个需批准的公开群组,群类型应该是EMGroupStylePublicJoinNeedApproval
  1649. *
  1650. * @param aGroupId 公开群组的ID
  1651. * @param aMessage 请求加入的信息
  1652. * @param aCompletionBlock 完成的回调
  1653. *
  1654. *
  1655. * \~english
  1656. * Request to join a public group, group style should be EMGroupStylePublicJoinNeedApproval
  1657. *
  1658. * @param aGroupId Public group id
  1659. * @param aMessage Apply info
  1660. * @param aCompletionBlock The callback block of completion
  1661. *
  1662. */
  1663. - (void)requestToJoinPublicGroup:(NSString *)aGroupId
  1664. message:(NSString *)aMessage
  1665. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1666. #pragma mark - Application
  1667. /*!
  1668. * \~chinese
  1669. * 批准入群申请, 需要Owner权限
  1670. *
  1671. * 同步方法,会阻塞当前线程
  1672. *
  1673. * @param aGroupId 所申请的群组ID
  1674. * @param aUsername 申请人
  1675. *
  1676. * @result 错误信息
  1677. *
  1678. * \~english
  1679. * Accept a group request, owner‘s authority is required
  1680. *
  1681. * Synchronization method will block the current thread
  1682. *
  1683. * @param aGroupId Group id
  1684. * @param aUsername The applicant
  1685. *
  1686. * @result Error
  1687. */
  1688. - (EMError *)acceptJoinApplication:(NSString *)aGroupId
  1689. applicant:(NSString *)aUsername;
  1690. /*!
  1691. * \~chinese
  1692. * 批准入群申请, 需要Owner权限
  1693. *
  1694. * @param aGroupId 所申请的群组ID
  1695. * @param aUsername 申请人
  1696. * @param aCompletionBlock 完成的回调
  1697. *
  1698. *
  1699. * \~english
  1700. * Approve a group request, owner‘s authority is required
  1701. *
  1702. * @param aGroupId Group id
  1703. * @param aUsername Group request sender
  1704. * @param aCompletionBlock The callback block of completion
  1705. *
  1706. */
  1707. - (void)approveJoinGroupRequest:(NSString *)aGroupId
  1708. sender:(NSString *)aUsername
  1709. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1710. /*!
  1711. * \~chinese
  1712. * 拒绝入群申请, 需要Owner权限
  1713. *
  1714. * 同步方法,会阻塞当前线程
  1715. *
  1716. * @param aGroupId 被拒绝的群组ID
  1717. * @param aUsername 申请人
  1718. * @param aReason 拒绝理由
  1719. *
  1720. * @result 错误信息
  1721. *
  1722. * \~english
  1723. * Decline a group request, owner‘s authority is required
  1724. *
  1725. * Synchronization method will block the current thread
  1726. *
  1727. * @param aGroupId Group id
  1728. * @param aUsername Group request sender
  1729. * @param aReason Decline reason
  1730. *
  1731. * @result Error
  1732. */
  1733. - (EMError *)declineJoinApplication:(NSString *)aGroupId
  1734. applicant:(NSString *)aUsername
  1735. reason:(NSString *)aReason;
  1736. /*!
  1737. * \~chinese
  1738. * 拒绝入群申请, 需要Owner权限
  1739. *
  1740. * @param aGroupId 被拒绝的群组ID
  1741. * @param aUsername 申请人
  1742. * @param aReason 拒绝理由
  1743. * @param aCompletionBlock 完成的回调
  1744. *
  1745. *
  1746. * \~english
  1747. * Decline a group request, owner‘s authority is required
  1748. *
  1749. * @param aGroupId Group id
  1750. * @param aUsername Group request sender
  1751. * @param aReason Decline reason
  1752. * @param aCompletionBlock The callback block of completion
  1753. *
  1754. */
  1755. - (void)declineJoinGroupRequest:(NSString *)aGroupId
  1756. sender:(NSString *)aUsername
  1757. reason:(NSString *)aReason
  1758. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1759. /*!
  1760. * \~chinese
  1761. * 接受入群邀请
  1762. *
  1763. * 同步方法,会阻塞当前线程
  1764. *
  1765. * @param groupId 接受的群组ID
  1766. * @param aUsername 邀请者
  1767. * @param pError 错误信息
  1768. *
  1769. * @result 接受的群组实例
  1770. *
  1771. * \~english
  1772. * Accept a group invitation
  1773. *
  1774. * Synchronization method will block the current thread
  1775. *
  1776. * @param aGroupId Group id
  1777. * @param aUsername Inviter
  1778. * @param pError Error
  1779. *
  1780. * @result Joined group instance
  1781. */
  1782. - (EMGroup *)acceptInvitationFromGroup:(NSString *)aGroupId
  1783. inviter:(NSString *)aUsername
  1784. error:(EMError **)pError;
  1785. /*!
  1786. * \~chinese
  1787. * 接受入群邀请
  1788. *
  1789. * @param groupId 接受的群组ID
  1790. * @param aUsername 邀请者
  1791. * @param pError 错误信息
  1792. * @param aCompletionBlock 完成的回调
  1793. *
  1794. *
  1795. * \~english
  1796. * Accept a group invitation
  1797. *
  1798. * @param aGroupId Group id
  1799. * @param aUsername Inviter
  1800. * @param aCompletionBlock The callback block of completion
  1801. *
  1802. */
  1803. - (void)acceptInvitationFromGroup:(NSString *)aGroupId
  1804. inviter:(NSString *)aUsername
  1805. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1806. /*!
  1807. * \~chinese
  1808. * 拒绝入群邀请
  1809. *
  1810. * 同步方法,会阻塞当前线程
  1811. *
  1812. * @param aGroupId 被拒绝的群组ID
  1813. * @param aUsername 邀请人
  1814. * @param aReason 拒绝理由
  1815. *
  1816. * @result 错误信息
  1817. *
  1818. * \~english
  1819. * Decline a group invitation
  1820. *
  1821. * Synchronization method will block the current thread
  1822. *
  1823. * @param aGroupId Group id
  1824. * @param aUsername Inviter
  1825. * @param aReason Decline reason
  1826. *
  1827. * @result Error
  1828. */
  1829. - (EMError *)declineInvitationFromGroup:(NSString *)aGroupId
  1830. inviter:(NSString *)aUsername
  1831. reason:(NSString *)aReason;
  1832. /*!
  1833. * \~chinese
  1834. * 拒绝入群邀请
  1835. *
  1836. * @param aGroupId 被拒绝的群组ID
  1837. * @param aInviter 邀请人
  1838. * @param aReason 拒绝理由
  1839. * @param aCompletionBlock 完成的回调
  1840. *
  1841. *
  1842. * \~english
  1843. * Decline a group invitation
  1844. *
  1845. * @param aGroupId Group id
  1846. * @param aInviter Inviter
  1847. * @param aReason Decline reason
  1848. * @param aCompletionBlock The callback block of completion
  1849. *
  1850. */
  1851. - (void)declineGroupInvitation:(NSString *)aGroupId
  1852. inviter:(NSString *)aInviter
  1853. reason:(NSString *)aReason
  1854. completion:(void (^)(EMError *aError))aCompletionBlock;
  1855. #pragma mark - Apns
  1856. /*!
  1857. * \~chinese
  1858. * 屏蔽/取消屏蔽群组消息的推送
  1859. *
  1860. * 同步方法,会阻塞当前线程
  1861. *
  1862. * @param aGroupId 群组ID
  1863. * @param aIgnore 是否屏蔽
  1864. *
  1865. * @result 错误信息
  1866. *
  1867. * \~english
  1868. * Block/unblock group message‘s push notification
  1869. *
  1870. * Synchronization method will block the current thread
  1871. *
  1872. * @param aGroupId Group id
  1873. * @param aIsIgnore Show/ignore push notificatino
  1874. *
  1875. * @result Error
  1876. */
  1877. - (EMError *)ignoreGroupPush:(NSString *)aGroupId
  1878. ignore:(BOOL)aIsIgnore;
  1879. /*!
  1880. * \~chinese
  1881. * 屏蔽/取消屏蔽群组消息的推送
  1882. *
  1883. * 同步方法,会阻塞当前线程
  1884. *
  1885. * @param aGroupIDs 群组ID列表
  1886. * @param aIgnore 是否屏蔽
  1887. *
  1888. * @result 错误信息
  1889. *
  1890. * \~english
  1891. * Block/unblock group message‘s push notification
  1892. *
  1893. * Synchronization method will block the current thread
  1894. *
  1895. * @param aGroupIDs Group ids list
  1896. * @param aIsIgnore Show or ignore push notification
  1897. *
  1898. * @result Error
  1899. */
  1900. - (EMError *)ignoreGroupsPush:(NSArray *)aGroupIDs
  1901. ignore:(BOOL)aIsIgnore;
  1902. /*!
  1903. * \~chinese
  1904. * 屏蔽/取消屏蔽群组消息的推送
  1905. *
  1906. * @param aGroupId 群组ID
  1907. * @param aIsEnable 是否允许推送
  1908. * @param aCompletionBlock 完成的回调
  1909. *
  1910. *
  1911. * \~english
  1912. * Block/unblock group message‘s push notification
  1913. *
  1914. * @param aGroupId Group id
  1915. * @param aIsEnable Whether enable
  1916. * @param aCompletionBlock The callback block of completion
  1917. *
  1918. */
  1919. - (void)updatePushServiceForGroup:(NSString *)aGroupId
  1920. isPushEnabled:(BOOL)aIsEnable
  1921. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;
  1922. /*!
  1923. * \~chinese
  1924. * 屏蔽/取消屏蔽群组消息的推送
  1925. *
  1926. * @param aGroupIDs 群组ID列表
  1927. * @param aIsEnable 是否允许推送
  1928. * @param aCompletionBlock 完成的回调
  1929. *
  1930. *
  1931. * \~english
  1932. * Block/unblock group message‘s push notification
  1933. *
  1934. * @param aGroupIDs Group ids list
  1935. * @param aIsEnable Whether enable
  1936. * @param aCompletionBlock The callback block of completion
  1937. *
  1938. */
  1939. - (void)updatePushServiceForGroups:(NSArray *)aGroupIDs
  1940. isPushEnabled:(BOOL)aIsEnable
  1941. completion:(void (^)(NSArray *groups, EMError *aError))aCompletionBlock;
  1942. #pragma mark - EM_DEPRECATED_IOS 3.3.0
  1943. /**
  1944. * \~chinese
  1945. * 从服务器获取用户所有的群组,成功后更新DB和内存中的群组列表
  1946. *
  1947. * 同步方法,会阻塞当前线程
  1948. *
  1949. * @param pError 错误信息
  1950. *
  1951. * @return 群组列表<EMGroup>
  1952. *
  1953. * \~english
  1954. * Get all of user's groups from server
  1955. *
  1956. * Synchronization method will block the current thread
  1957. *
  1958. * @param pError Error
  1959. *
  1960. * @result Group list<EMGroup>
  1961. */
  1962. - (NSArray *)getMyGroupsFromServerWithError:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getJoinedGroupsFromServerWithPage:pageSize:error:]");
  1963. /**
  1964. * \~chinese
  1965. * 从服务器获取用户所有的群组,成功后更新DB和内存中的群组列表
  1966. *
  1967. * @param aCompletionBlock 完成的回调
  1968. *
  1969. *
  1970. * \~english
  1971. * Get all of user's groups from server
  1972. *
  1973. * @param aCompletionBlock The callback block of completion
  1974. *
  1975. */
  1976. - (void)getJoinedGroupsFromServerWithCompletion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getJoinedGroupsFromServerWithPage:pageSize:completion:]");
  1977. /*!
  1978. * \~chinese
  1979. * 获取群组详情
  1980. *
  1981. * 同步方法,会阻塞当前线程
  1982. *
  1983. * @param aGroupId 群组ID
  1984. * @param aIncludeMembersList 是否获取成员列表,为YES时,返回200个成员
  1985. * @param pError 错误信息
  1986. *
  1987. * @return 群组
  1988. *
  1989. * \~english
  1990. * Fetch group info
  1991. *
  1992. * Synchronization method will block the current thread
  1993. *
  1994. * @param aGroupId Group id
  1995. * @param aIncludeMembersList Whether to get member list,When YES, returns 200 members
  1996. * @param pError Error
  1997. *
  1998. * @return Group instance
  1999. */
  2000. - (EMGroup *)fetchGroupInfo:(NSString *)aGroupId
  2001. includeMembersList:(BOOL)aIncludeMembersList
  2002. error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getGroupSpecificationFromServerWithId:error:]");
  2003. /*!
  2004. * \~chinese
  2005. * 获取群组详情
  2006. *
  2007. * @param aGroupId 群组ID
  2008. * @param aIncludeMembersList 是否获取成员列表,为YES时,返回200个成员
  2009. * @param aCompletionBlock 完成的回调
  2010. *
  2011. *
  2012. * \~english
  2013. * Fetch group specification
  2014. *
  2015. * @param aGroupId Group id
  2016. * @param aIncludeMembersList Whether to get member list,When YES, returns 200 members
  2017. * @param aCompletionBlock The callback block of completion
  2018. *
  2019. */
  2020. - (void)getGroupSpecificationFromServerByID:(NSString *)aGroupID
  2021. includeMembersList:(BOOL)aIncludeMembersList
  2022. completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getGroupSpecificationFromServerWithId:completion:]");
  2023. /*!
  2024. * \~chinese
  2025. * 获取群组黑名单列表, 需要owner权限
  2026. *
  2027. * 同步方法,会阻塞当前线程
  2028. *
  2029. * @param aGroupId 群组ID
  2030. * @param pError 错误信息
  2031. *
  2032. * @return 群组黑名单列表<NSString>
  2033. *
  2034. * \~english
  2035. * Get group‘s blacklist, required owner’s authority
  2036. *
  2037. * Synchronization method will block the current thread
  2038. *
  2039. * @param aGroupId Group id
  2040. * @param pError Error
  2041. *
  2042. * @return Group blacklist<NSString>
  2043. */
  2044. - (NSArray *)fetchGroupBansList:(NSString *)aGroupId
  2045. error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:]");
  2046. /*!
  2047. * \~chinese
  2048. * 获取群组黑名单列表, 需要owner权限
  2049. *
  2050. * @param aGroupId 群组ID
  2051. * @param aCompletionBlock 完成的回调
  2052. *
  2053. *
  2054. * \~english
  2055. * Get group's blacklist, owner’s authority is required
  2056. *
  2057. * @param aGroupId Group id
  2058. * @param aCompletionBlock The callback block of completion
  2059. *
  2060. */
  2061. - (void)getGroupBlackListFromServerByID:(NSString *)aGroupId
  2062. completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:]");
  2063. /*!
  2064. * \~chinese
  2065. * 解散群组, 需要owner权限
  2066. *
  2067. * 同步方法,会阻塞当前线程
  2068. *
  2069. * @param aGroupId 群组ID
  2070. * @param pError 错误信息
  2071. *
  2072. * @result 销毁的群组实例, 失败返回nil
  2073. *
  2074. * \~english
  2075. * Destroy a group, owner‘s authority is required
  2076. *
  2077. * Synchronization method will block the current thread
  2078. *
  2079. * @param aGroupId Group id
  2080. * @param pError Error
  2081. *
  2082. * @result Destroyed group, return nil if failed
  2083. */
  2084. - (EMGroup *)destroyGroup:(NSString *)aGroupId
  2085. error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager destroyGroup:]");
  2086. /*!
  2087. * \~chinese
  2088. * 解散群组, 需要owner权限
  2089. *
  2090. * @param aGroupId 群组ID
  2091. * @param aCompletionBlock 完成的回调
  2092. *
  2093. * \~english
  2094. * Destroy a group, owner‘s authority is required
  2095. *
  2096. * @param aGroupId Group id
  2097. * @param aCompletionBlock The callback block of completion
  2098. *
  2099. */
  2100. - (void)destroyGroup:(NSString *)aGroupId
  2101. completion:(void (^)(EMGroup* aGroup, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMGroupManager destroyGroup:finishCompletion:]");
  2102. #pragma mark - EM_DEPRECATED_IOS 3.2.3
  2103. /*!
  2104. * \~chinese
  2105. * 添加回调代理
  2106. *
  2107. * @param aDelegate 要添加的代理
  2108. *
  2109. * \~english
  2110. * Add delegate
  2111. *
  2112. * @param aDelegate Delegate
  2113. */
  2114. - (void)addDelegate:(id<EMGroupManagerDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMGroupManager addDelegate:delegateQueue:]");
  2115. #pragma mark - EM_DEPRECATED_IOS < 3.2.3
  2116. /*!
  2117. * \~chinese
  2118. * 获取所有群组,如果内存中不存在,则先从DB加载
  2119. *
  2120. * @result 群组列表<EMGroup>
  2121. *
  2122. * \~english
  2123. * Get all groups, will load from DB if not exist in memory
  2124. *
  2125. * @result Group list<EMGroup>
  2126. */
  2127. - (NSArray *)getAllGroups __deprecated_msg("Use -getJoinedGroups");
  2128. /*!
  2129. * \~chinese
  2130. * 从数据库加载所有群组,加载后更新内存中的群组列表
  2131. *
  2132. * @result 群组列表<EMGroup>
  2133. *
  2134. * \~english
  2135. * Load all groups from DB, will update group list in memory after loading
  2136. *
  2137. * @result Group list<EMGroup>
  2138. */
  2139. - (NSArray *)loadAllMyGroupsFromDB __deprecated_msg("Use -getJoinedGroups");
  2140. /*!
  2141. * \~chinese
  2142. * 从内存中获取屏蔽了推送的群组ID列表
  2143. *
  2144. * @result 群组ID列表<NSString>
  2145. *
  2146. * \~english
  2147. * Get ID list of groups which block push from memory
  2148. *
  2149. * @result Group id list<NSString>
  2150. */
  2151. - (NSArray *)getAllIgnoredGroupIds __deprecated_msg("Use -getGroupsWithoutPushNotification");
  2152. /**
  2153. * \~chinese
  2154. * 从服务器获取用户所有的群组,成功后更新DB和内存中的群组列表
  2155. *
  2156. * @param aSuccessBlock 成功的回调
  2157. * @param aFailureBlock 失败的回调
  2158. *
  2159. *
  2160. * \~english
  2161. * Get all of user's groups from server, will update group list in memory and DB after success
  2162. *
  2163. * @param aSuccessBlock The callback block of success
  2164. * @param aFailureBlock The callback block of failure
  2165. *
  2166. */
  2167. - (void)asyncGetMyGroupsFromServer:(void (^)(NSArray *aList))aSuccessBlock
  2168. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getJoinedGroupsFromServerWithCompletion:");
  2169. /*!
  2170. * \~chinese
  2171. * 从服务器获取指定范围内的公开群
  2172. *
  2173. * @param aCursor 获取公开群的cursor,首次调用传空
  2174. * @param aPageSize 期望返回结果的数量, 如果 < 0 则一次返回所有结果
  2175. * @param aSuccessBlock 成功的回调
  2176. * @param aFailureBlock 失败的回调
  2177. *
  2178. *
  2179. * \~english
  2180. * Get public groups in the specified range from the server
  2181. *
  2182. * @param aCursor Cursor, input nil the first time
  2183. * @param aPageSize Expect result count, will return all results if < 0
  2184. * @param aSuccessBlock The callback block of success
  2185. * @param aFailureBlock The callback block of failure
  2186. *
  2187. */
  2188. - (void)asyncGetPublicGroupsFromServerWithCursor:(NSString *)aCursor
  2189. pageSize:(NSInteger)aPageSize
  2190. success:(void (^)(EMCursorResult *aCursor))aSuccessBlock
  2191. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getPublicGroupsFromServerWithCursor:pageSize:completion:");
  2192. /*!
  2193. * \~chinese
  2194. * 根据群ID搜索公开群
  2195. *
  2196. * @param aGroundId 群组id
  2197. * @param aSuccessBlock 成功的回调
  2198. * @param aFailureBlock 失败的回调
  2199. *
  2200. *
  2201. * \~english
  2202. * Search public group with the id
  2203. *
  2204. * @param aGroundId Group id
  2205. * @param aSuccessBlock The callback block of success
  2206. * @param aFailureBlock The callback block of failure
  2207. *
  2208. */
  2209. - (void)asyncSearchPublicGroupWithId:(NSString *)aGroundId
  2210. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2211. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -searchPublicGroupWithId:completion:");
  2212. /*!
  2213. * \~chinese
  2214. * 创建群组
  2215. *
  2216. * @param aSubject 群组名称
  2217. * @param aDescription 群组描述
  2218. * @param aInvitees 群组成员(不包括创建者自己)
  2219. * @param aMessage 邀请消息
  2220. * @param aSetting 群组属性
  2221. * @param aSuccessBlock The callback block of success
  2222. * @param aFailureBlock The callback block of failure
  2223. *
  2224. *
  2225. * \~english
  2226. * Create a group
  2227. *
  2228. * @param aSubject Group subject
  2229. * @param aDescription Group description
  2230. * @param aInvitees Group members, without creater
  2231. * @param aMessage Invitation message
  2232. * @param aSetting Group options
  2233. * @param aSuccessBlock The callback block of success
  2234. * @param aFailureBlock The callback block of failure
  2235. *
  2236. */
  2237. - (void)asyncCreateGroupWithSubject:(NSString *)aSubject
  2238. description:(NSString *)aDescription
  2239. invitees:(NSArray *)aInvitees
  2240. message:(NSString *)aMessage
  2241. setting:(EMGroupOptions *)aSetting
  2242. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2243. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -createGroupWithSubject:description:invitees:message:setting:completion");
  2244. /*!
  2245. * \~chinese
  2246. * 获取群组详情
  2247. *
  2248. * @param aGroupId 群组ID
  2249. * @param aIncludeMembersList 是否获取成员列表
  2250. * @param aSuccessBlock 成功的回调
  2251. * @param aFailureBlock 失败的回调
  2252. *
  2253. *
  2254. * \~english
  2255. * Fetch group info
  2256. *
  2257. * @param aGroupId Group id
  2258. * @param aIncludeMembersList Whether get member list
  2259. * @param aSuccessBlock The callback block of success
  2260. * @param aFailureBlock The callback block of failure
  2261. *
  2262. */
  2263. - (void)asyncFetchGroupInfo:(NSString *)aGroupId
  2264. includeMembersList:(BOOL)aIncludeMembersList
  2265. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2266. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getGroupSpecificationFromServerByID:includeMembersList:completion:");
  2267. /*!
  2268. * \~chinese
  2269. * 获取群组黑名单列表, 需要owner权限
  2270. *
  2271. * @param aGroupId 群组ID
  2272. * @param aSuccessBlock 成功的回调
  2273. * @param aFailureBlock 失败的回调
  2274. *
  2275. *
  2276. * \~english
  2277. * Get group‘s blacklist, need owner’s authority
  2278. *
  2279. * @param aGroupId Group id
  2280. * @param aSuccessBlock The callback block of success
  2281. * @param aFailureBlock The callback block of failure
  2282. *
  2283. */
  2284. - (void)asyncFetchGroupBansList:(NSString *)aGroupId
  2285. success:(void (^)(NSArray *aList))aSuccessBlock
  2286. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getGroupBlackListFromServerByID:completion:");
  2287. /*!
  2288. * \~chinese
  2289. * 邀请用户加入群组
  2290. *
  2291. * @param aOccupants 被邀请的用户名列表
  2292. * @param aGroupId 群组ID
  2293. * @param aWelcomeMessage 欢迎信息
  2294. * @param aSuccessBlock 成功的回调
  2295. * @param aFailureBlock 失败的回调
  2296. *
  2297. *
  2298. * \~english
  2299. * Invite User to join a group
  2300. *
  2301. * @param aOccupants Invited users
  2302. * @param aGroupId Group id
  2303. * @param aWelcomeMessage Welcome message
  2304. * @param aSuccessBlock The callback block of success
  2305. * @param aFailureBlock The callback block of failure
  2306. *
  2307. */
  2308. - (void)asyncAddOccupants:(NSArray *)aOccupants
  2309. toGroup:(NSString *)aGroupId
  2310. welcomeMessage:(NSString *)aWelcomeMessage
  2311. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2312. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -addMembers:toGroup:message:completion:");
  2313. /*!
  2314. * \~chinese
  2315. * 将群成员移出群组, 需要owner权限
  2316. *
  2317. * @param aOccupants 要移出群组的用户列表
  2318. * @param aGroupId 群组ID
  2319. * @param aSuccessBlock 成功的回调
  2320. * @param aFailureBlock 失败的回调
  2321. *
  2322. *
  2323. * \~english
  2324. * Remove members from group, need owner‘s authority
  2325. *
  2326. * @param aOccupants Users to be removed
  2327. * @param aGroupId Group id
  2328. * @param aSuccessBlock The callback block of success
  2329. * @param aFailureBlock The callback block of failure
  2330. *
  2331. */
  2332. - (void)asyncRemoveOccupants:(NSArray *)aOccupants
  2333. fromGroup:(NSString *)aGroupId
  2334. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2335. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -removeMembers:fromGroup:completion:");
  2336. /*!
  2337. * \~chinese
  2338. * 加人到群组黑名单, 需要owner权限
  2339. *
  2340. * @param aOccupants 要加入黑名单的用户
  2341. * @param aGroupId 群组ID
  2342. * @param aSuccessBlock 成功的回调
  2343. * @param aFailureBlock 失败的回调
  2344. *
  2345. *
  2346. * \~english
  2347. * Add users to group’s blacklist, need owner‘s authority
  2348. *
  2349. * @param aOccupants Users to be added
  2350. * @param aGroupId Group id
  2351. * @param aSuccessBlock The callback block of success
  2352. * @param aFailureBlock The callback block of failure
  2353. *
  2354. */
  2355. - (void)asyncBlockOccupants:(NSArray *)aOccupants
  2356. fromGroup:(NSString *)aGroupId
  2357. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2358. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -blockMembers:fromGroup:completion:");
  2359. /*!
  2360. * \~chinese
  2361. * 从群组黑名单中减人, 需要owner权限
  2362. *
  2363. * @param aOccupants 要从黑名单中移除的用户名列表
  2364. * @param aGroupId 群组ID
  2365. * @param aSuccessBlock 成功的回调
  2366. * @param aFailureBlock 失败的回调
  2367. *
  2368. *
  2369. * \~english
  2370. * Remove users from group‘s blacklist, need owner‘s authority
  2371. *
  2372. * @param aOccupants Users to be removed
  2373. * @param aGroupId Group id
  2374. * @param aSuccessBlock The callback block of success
  2375. * @param aFailureBlock The callback block of failure
  2376. *
  2377. */
  2378. - (void)asyncUnblockOccupants:(NSArray *)aOccupants
  2379. forGroup:(NSString *)aGroupId
  2380. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2381. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -unblockMembers:fromGroup:completion:");
  2382. /*!
  2383. * \~chinese
  2384. * 更改群组主题, 需要owner权限
  2385. *
  2386. * @param aSubject 新主题
  2387. * @param aGroupId 群组ID
  2388. * @param aSuccessBlock 成功的回调
  2389. * @param aFailureBlock 失败的回调
  2390. *
  2391. *
  2392. * \~english
  2393. * Change group’s subject, need owner‘s authority
  2394. *
  2395. * @param aSubject New group‘s subject
  2396. * @param aGroupId Group id
  2397. * @param aSuccessBlock The callback block of success
  2398. * @param aFailureBlock The callback block of failure
  2399. *
  2400. */
  2401. - (void)asyncChangeGroupSubject:(NSString *)aSubject
  2402. forGroup:(NSString *)aGroupId
  2403. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2404. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -updateGroupSubject:forGroup:completion");
  2405. /*!
  2406. * \~chinese
  2407. * 更改群组说明信息, 需要owner权限
  2408. *
  2409. * @param aDescription 说明信息
  2410. * @param aGroupId 群组ID
  2411. * @param aSuccessBlock 成功的回调
  2412. * @param aFailureBlock 失败的回调
  2413. *
  2414. *
  2415. * \~english
  2416. * Change group’s description, need owner‘s authority
  2417. *
  2418. * @param aDescription New group‘s description
  2419. * @param aGroupId Group id
  2420. * @param aSuccessBlock The callback block of success
  2421. * @param aFailureBlock The callback block of failure
  2422. *
  2423. */
  2424. - (void)asyncChangeDescription:(NSString *)aDescription
  2425. forGroup:(NSString *)aGroupId
  2426. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2427. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -updateDescription:forGroup:completion");
  2428. /*!
  2429. * \~chinese
  2430. * 退出群组,owner不能退出群,只能销毁群
  2431. *
  2432. * @param aGroupId 群组ID
  2433. * @param aSuccessBlock 成功的回调
  2434. * @param aFailureBlock 失败的回调
  2435. *
  2436. *
  2437. * \~english
  2438. * Leave a group, owner can't leave the group, can only destroy the group
  2439. *
  2440. * @param aGroupId Group id
  2441. * @param aSuccessBlock The callback block of success
  2442. * @param aFailureBlock The callback block of failure
  2443. *
  2444. */
  2445. - (void)asyncLeaveGroup:(NSString *)aGroupId
  2446. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2447. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -leaveGroup:completion");
  2448. /*!
  2449. * \~chinese
  2450. * 解散群组, 需要owner权限
  2451. *
  2452. * @param aGroupId 群组ID
  2453. * @param aSuccessBlock 成功的回调
  2454. * @param aFailureBlock 失败的回调
  2455. *
  2456. * \~english
  2457. * Destroy a group, need owner‘s authority
  2458. *
  2459. * @param aGroupId Group id
  2460. * @param aSuccessBlock The callback block of success
  2461. * @param aFailureBlock The callback block of failure
  2462. *
  2463. */
  2464. - (void)asyncDestroyGroup:(NSString *)aGroupId
  2465. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2466. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -destroyGroup:completion");
  2467. /*!
  2468. * \~chinese
  2469. * 屏蔽群消息,服务器不再发送此群的消息给用户,owner不能屏蔽群消息
  2470. *
  2471. * @param aGroupId 要屏蔽的群ID
  2472. * @param aSuccessBlock 成功的回调
  2473. * @param aFailureBlock 失败的回调
  2474. *
  2475. * \~english
  2476. * Block group’s message, server will blocks the messages of the group to user, owner can't block the group's message
  2477. *
  2478. * @param aGroupId Group id
  2479. * @param aSuccessBlock The callback block of success
  2480. * @param aFailureBlock The callback block of failure
  2481. *
  2482. */
  2483. - (void)asyncBlockGroup:(NSString *)aGroupId
  2484. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2485. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -blockGroup:completion:");
  2486. /*!
  2487. * \~chinese
  2488. * 取消屏蔽群消息
  2489. *
  2490. * @param aGroupId 要取消屏蔽的群ID
  2491. * @param aSuccessBlock 成功的回调
  2492. * @param aFailureBlock 失败的回调
  2493. *
  2494. * \~english
  2495. * Unblock group message
  2496. *
  2497. * @param aGroupId Group id
  2498. * @param aSuccessBlock The callback block of success
  2499. * @param aFailureBlock The callback block of failure
  2500. *
  2501. */
  2502. - (void)asyncUnblockGroup:(NSString *)aGroupId
  2503. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2504. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -unblockGroup:completion");
  2505. /*!
  2506. * \~chinese
  2507. * 加入一个公开群组,群类型应该是EMGroupStylePublicOpenJoin
  2508. *
  2509. * @param aGroupId 公开群组的ID
  2510. * @param aSuccessBlock 成功的回调
  2511. * @param aFailureBlock 失败的回调
  2512. *
  2513. * \~english
  2514. * Join a public group, group style should be EMGroupStylePublicOpenJoin
  2515. *
  2516. * @param aGroupId Public group id
  2517. * @param aSuccessBlock The callback block of success
  2518. * @param aFailureBlock The callback block of failure
  2519. *
  2520. */
  2521. - (void)asyncJoinPublicGroup:(NSString *)aGroupId
  2522. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2523. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -joinPublicGroup:completion");
  2524. /*!
  2525. * \~chinese
  2526. * 申请加入一个需批准的公开群组,群类型应该是EMGroupStylePublicJoinNeedApproval
  2527. *
  2528. * @param aGroupId 公开群组的ID
  2529. * @param aMessage 请求加入的信息
  2530. * @param aSuccessBlock 成功的回调
  2531. * @param aFailureBlock 失败的回调
  2532. *
  2533. *
  2534. * \~english
  2535. * Apply to join a public group, group style should be EMGroupStylePublicJoinNeedApproval
  2536. *
  2537. * @param aGroupId Public group id
  2538. * @param aMessage Apply info
  2539. * @param aSuccessBlock The callback block of success
  2540. * @param aFailureBlock The callback block of failure
  2541. *
  2542. */
  2543. - (void)asyncApplyJoinPublicGroup:(NSString *)aGroupId
  2544. message:(NSString *)aMessage
  2545. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2546. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -requestToJoinPublicGroup:message:completion:");
  2547. /*!
  2548. * \~chinese
  2549. * 批准入群申请, 需要Owner权限
  2550. *
  2551. * @param aGroupId 所申请的群组ID
  2552. * @param aUsername 申请人
  2553. * @param aSuccessBlock 成功的回调
  2554. * @param aFailureBlock 失败的回调
  2555. *
  2556. *
  2557. * \~english
  2558. * Accept user's application, need owner‘s authority
  2559. *
  2560. * @param aGroupId Group id
  2561. * @param aUsername The applicant
  2562. * @param aSuccessBlock The callback block of success
  2563. * @param aFailureBlock The callback block of failure
  2564. *
  2565. */
  2566. - (void)asyncAcceptJoinApplication:(NSString *)aGroupId
  2567. applicant:(NSString *)aUsername
  2568. success:(void (^)())aSuccessBlock
  2569. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -approveJoinGroupRequest:sender:completion:");
  2570. /*!
  2571. * \~chinese
  2572. * 拒绝入群申请, 需要Owner权限
  2573. *
  2574. * @param aGroupId 被拒绝的群组ID
  2575. * @param aUsername 申请人
  2576. * @param aReason 拒绝理由
  2577. * @param aSuccessBlock 成功的回调
  2578. * @param aFailureBlock 失败的回调
  2579. *
  2580. *
  2581. * \~english
  2582. * Decline user's application, need owner‘s authority
  2583. *
  2584. * @param aGroupId Group id
  2585. * @param aUsername The applicant
  2586. * @param aReason Decline reason
  2587. * @param aSuccessBlock The callback block of success
  2588. * @param aFailureBlock The callback block of failure
  2589. *
  2590. */
  2591. - (void)asyncDeclineJoinApplication:(NSString *)aGroupId
  2592. applicant:(NSString *)aUsername
  2593. reason:(NSString *)aReason
  2594. success:(void (^)())aSuccessBlock
  2595. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -declineJoinGroupRequest:sender:reason:completion:");
  2596. /*!
  2597. * \~chinese
  2598. * 接受入群邀请
  2599. *
  2600. * @param groupId 接受的群组ID
  2601. * @param aUsername 邀请者
  2602. * @param pError 错误信息
  2603. * @param aSuccessBlock 成功的回调
  2604. * @param aFailureBlock 失败的回调
  2605. *
  2606. *
  2607. * \~english
  2608. * Accept group's invitation
  2609. *
  2610. * @param groupId Group id
  2611. * @param aUsername Inviter
  2612. * @param aSuccessBlock The callback block of success
  2613. * @param aFailureBlock The callback block of failure
  2614. *
  2615. */
  2616. - (void)asyncAcceptInvitationFromGroup:(NSString *)aGroupId
  2617. inviter:(NSString *)aUsername
  2618. success:(void (^)(EMGroup *aGroup))aSuccessBlock
  2619. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -acceptInvitationFromGroup:inviter:completion");
  2620. /*!
  2621. * \~chinese
  2622. * 拒绝入群邀请
  2623. *
  2624. * @param aGroupId 被拒绝的群组ID
  2625. * @param aUsername 邀请人
  2626. * @param aReason 拒绝理由
  2627. * @param aSuccessBlock 成功的回调
  2628. * @param aFailureBlock 失败的回调
  2629. *
  2630. *
  2631. * \~english
  2632. * Decline a group invitation
  2633. *
  2634. * @param aGroupId Group id
  2635. * @param aUsername Inviter
  2636. * @param aReason Decline reason
  2637. * @param aSuccessBlock The callback block of success
  2638. * @param aFailureBlock The callback block of failure
  2639. *
  2640. */
  2641. - (void)asyncDeclineInvitationFromGroup:(NSString *)aGroupId
  2642. inviter:(NSString *)aUsername
  2643. reason:(NSString *)aReason
  2644. success:(void (^)())aSuccessBlock
  2645. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -declineGroupInvitation:inviter:reason:completion:");
  2646. /*!
  2647. * \~chinese
  2648. * 屏蔽/取消屏蔽群组消息的推送
  2649. *
  2650. * @param aGroupId 群组ID
  2651. * @param aIgnore 是否屏蔽
  2652. * @param aSuccessBlock 成功的回调
  2653. * @param aFailureBlock 失败的回调
  2654. *
  2655. *
  2656. * \~english
  2657. * Block / unblock group message‘s push notification
  2658. *
  2659. * @param aGroupId Group id
  2660. * @param aIgnore Whether block
  2661. * @param aSuccessBlock The callback block of success
  2662. * @param aFailureBlock The callback block of failure
  2663. *
  2664. */
  2665. - (void)asyncIgnoreGroupPush:(NSString *)aGroupId
  2666. ignore:(BOOL)aIsIgnore
  2667. success:(void (^)())aSuccessBlock
  2668. failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -updatePushServiceForGroup:isPushEnabled:completion:");
  2669. @end