即时通讯 IM iOS API 参考

接受入群邀请。

异步方法。

参数

groupId	接受的群组 ID。
aUsername	邀请者。
pError	错误信息。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

接受入群邀请。

同步方法，会阻塞当前线程。

参数

groupId	接受的群组 ID。
aUsername	邀请者。
pError	错误信息。

返回

接受的群组实例。

批准入群申请。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId	所申请的群组 ID。
aUsername	申请人。

返回

错误信息。

添加群组管理员。

异步方法。

该方法只有群主才有权限调用。

参数

aAdmin	要添加的群组管理员。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

添加群组管理员。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aAdmin	要添加的群组管理员。
aGroupId	群组 ID。
pError	错误信息。

返回

返回群组实例。

添加回调代理。

参数

aDelegate	要添加的代理。
aQueue	代理执行的队列，如果是空值，则在主线程。

邀请用户加入群组。

参数

aUsers	被邀请的用户名列表。
aGroupId	群组 ID。
aMessage	欢迎信息。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

邀请用户加入群组。

同步方法，会阻塞当前线程。

参数

aOccupants	被邀请的用户名列表。
aGroupId	群组 ID。
aWelcomeMessage	欢迎信息。
pError	错误信息。

返回

群组实例。失败返回空值。

添加白名单。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aMembers	要添加的成员列表。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

添加白名单。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aMuteMembers	要添加的成员列表。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

申请加入一个需批准的公开群组，群类型应该是 AgoraChatGroupStylePublicJoinNeedApproval。

同步方法，会阻塞当前线程。

参数

aGroupId	公开群组的 ID。
aMessage	请求加入的信息。
pError	错误信息。

返回

申请加入的公开群组。

批准入群申请。

该方法只有群主才有权限调用。

异步方法。

参数

aGroupId	所申请的群组 ID。
aUsername	申请人。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。

参数

aGroupId	要屏蔽的群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。

同步方法，会阻塞当前线程。

参数

aGroupId	要屏蔽的群 ID。
pError	错误信息。

返回

群组实例。

加人到群组黑名单。

该方法只有群主才有权限调用。

参数

aMembers	要加入黑名单的用户。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

加人到群组黑名单。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aOccupants	要加入黑名单的用户。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

更改群组说明信息。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aDescription	说明信息。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

更改群组主题。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aSubject	新主题。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

创建群组。

异步方法。

参数

aSubject	群组名称。
aDescription	群组描述。
aInvitees	群组成员，不包括创建者自己。
aMessage	加入群组的邀请消息。
aSetting	群组属性。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

创建群组。

同步方法，会阻塞当前线程。

参数

aSubject	群组名称。
aDescription	群组描述。
aInvitees	群组成员，不包括创建者自己。
aMessage	加入群组的邀请消息。
aSetting	群组属性。
pError	出错信息。

返回

群组实例。

拒绝入群邀请。

异步方法。

参数

aGroupId	被拒绝的群组 ID。
aInviter	邀请人。
aReason	拒绝理由。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

拒绝入群邀请。

同步方法，会阻塞当前线程。

参数

aGroupId	被拒绝的群组 ID。
aUsername	邀请人。
aReason	拒绝理由。

返回

错误信息。

拒绝入群申请。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId	被拒绝的群组 ID。
aUsername	申请人。
aReason	拒绝理由。

返回

错误信息。

拒绝入群申请。

该方法只有群主才有权限调用。

异步方法。

参数

aGroupId	被拒绝的群组 ID。
aUsername	申请人。
aReason	拒绝理由。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

解散群组。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId

群组 ID。

返回

AgoraChatError 错误信息。成功返回 nil。

解散群组。

该方法只有群主才有权限调用。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

下载群共享文件。

参数

aGroupId	群组 ID。
aFilePath	文件路径。
aSharedFileId	共享文件 ID。
aProgressBlock	文件下载进度回调。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组被禁言列表。

该方法只有群主和群管理员允许调用。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群公告。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群公告。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

群公告。失败返回空值。

获取群组黑名单列表。

该方法只有群主和管理员才有权限调用。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组黑名单列表。 这里需要注意的是：

• 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
• aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
• 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。

该方法只有群主和管理员才有权限调用。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
pError	错误信息。

返回

黑名单列表。

获取群共享文件列表。

异步方法。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群共享文件列表。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
pError	错误信息。

返回

群共享文件列表。

获取群组成员列表。 这里需要注意的是：

• 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
• aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
• 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。

参数

aGroupId	群组 ID。
aCursor	游标，首次调用传空。
aPageSize	获取多少条。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组成员列表。

这里需要注意的是：

• 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
• aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
• 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
aCursor	游标，首次调用传空。使用场景：第一次传 nil ，然后根据服务器返回的数据，其中有一个字段是 aCursor，保存本地，下次调用接口时，会把更新的aCursor 传入作为获取数据的标志位置。
aPageSize	调用接口时，指定期望返回的列表数据个数。
pError	错误信息。

返回

列表和游标。

获取群组被禁言列表。

该方法只有群主和群管理员允许调用。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组被禁言列表。

该方法只有群主和群管理员允许调用。

参数

aGroupId	群组 ID。
aPageNum	获取第几页。
aPageSize	获取多少条。
pError	错误信息。

返回

群组被禁言列表。

获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。

异步方法。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组详情，包含群组 ID, 群组名称，群组描述，群组基本属性，群主，群组管理员。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。

异步方法。

参数

aGroupId	群组 ID。
fetchMembers	是否获取群组成员，默认最多取 200 人数。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
fetchMembers	是否获取群组成员，默认最多取 200 人。
pError	错误信息。

返回

群组实例。

从内存中获取屏蔽了推送的群组 ID 列表。

参数

pError

错误信息。

返回

群组 ID 列表。

获取群组白名单列表。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

获取群组白名单列表。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

群组白名单列表。

获取用户所有群组。

返回

群组列表。

按数目从服务器获取自己加入的群组。

已废弃，请用 getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion: 代替。

异步方法。

参数

aPageNum	获取自己加入群的游标，首次调用传空。
aPageSize	期望返回结果的数量, 如果小于 0 则一次返回所有结果。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

按数目从服务器获取自己加入的群组。

这里需要注意的是：

• 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
• aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
• 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。

同步方法，会阻塞当前线程。

参数

aPageNum	获取自己加入群的游标，首次调用传空。
aPageSize	期望返回结果的数量, 如果小于 0 则一次返回所有结果。
pError	出错信息。

返回

群组列表。

从服务器分页获取当前用户加入的群组。

• 异步方法。

参数

aPageNum	当前页码，从 0 开始。该参数设置后，SDK 从指定位置按照用户加入群组的逆序查询。 首次查询设置为 0，SDK 从最新加入的群组开始查询。
aPageSize	每次期望获取的社区数量。取值范围为 [1,20]。
aNeedMemberCount	是否需要群组成员数。 YES：是； NO：否；
aNeedRole	是否需要当前用户的角色。 YES：是； NO：否；
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

从服务器获取指定范围内的公开群。

异步方法。

参数

aCursor	获取公开群的游标，首次调用传空。
aPageSize	期望返回结果的数量, 如果小于 0 则一次返回所有结果。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

从服务器获取指定范围内的公开群。

同步方法，会阻塞当前线程。

参数

aCursor	获取公开群的游标，首次调用传空。
aPageSize	期望返回结果的数量, 如果小于 0 则一次返回所有结果。
pError	出错信息。

返回

获取的公开群结果。

屏蔽/取消屏蔽群组消息的推送。

同步方法，会阻塞当前线程。

已废弃，请用 IAgoraChatPushManager::updatePushServiceForGroups:disablePush: 代替。

参数

aGroupId	群组 ID。
aIgnore	是否屏蔽。

返回

错误信息。

屏蔽/取消屏蔽群组消息的推送。

已废弃，请用 IAgoraChatPushManager::updatePushServiceForGroups:disablePush: 代替。

同步方法，会阻塞当前线程。

参数

aGroupIDs	群组 ID 列表。
aIgnore	是否屏蔽。

返回

错误信息。

查看自己是否在群组白名单中。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

查看自己是否在群组白名单中。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

布尔值。 YES: 在白名单； NO: 不在白名单。

加入一个公开群组，群类型应该是 AgoraChatGroupStylePublicOpenJoin。

参数

aGroupId	公开群组的 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

加入一个公开群组，群类型应该是 AgoraChatGroupStylePublicOpenJoin。

同步方法，会阻塞当前线程。

参数

aGroupId	公开群组的 ID。
pError	错误信息。

返回

所加入的公开群组。

退出群组，群主不能退出群，只能销毁群。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

退出群组，群主不能退出群，只能销毁群。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
pError	错误信息。

设置全员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

设置全员禁言。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

将一组成员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aMuteMembers	要禁言的成员列表。
aMuteMilliseconds	禁言时长。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

将一组成员禁言。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aMuteMembers	要禁言的成员列表。
aMuteMilliseconds	禁言时长。
aGroupId	群组 ID。
pError	错误信息。

返回

返回群组实例。

移除群组管理员。

该方法只有群主才有权限调用。

异步方法。

参数

aAdmin	要移除的群组管理员。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

移除群组管理员。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aAdmin	要移除的群组管理员。
aGroupId	群组 ID。
pError	错误信息。

返回

返回群组实例。

移除回调代理。

参数

aDelegate

要移除的代理。

删除群共享文件。

参数

aGroupId	群组 ID。
aSharedFileId	共享文件 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

删除群共享文件。

参数

aGroupId	群组 ID。
aSharedFileId	共享文件 ID。
pError	错误信息。

返回

群组实例。

将群成员移出群组。

该方法只有群主才有权限调用。

参数

aUsers	要移出群组的用户列表。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

将群成员移出群组。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aOccupants	要移出群组的用户列表。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

移除白名单。

异步方法。

该方法只有管理员或者群主才有权限调用。

参数

aMembers	被移除的列表。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

移除白名单。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aMuteMembers	要添加的成员列表。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

申请加入一个需批准的公开群组，群类型应该是 AgoraChatGroupStylePublicJoinNeedApproval。

参数

aGroupId	公开群组的 ID。
aMessage	请求加入的信息。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

根据群组 ID 搜索公开群。

参数

aGroundId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

根据群组 ID 搜索公开群。

同步方法，会阻塞当前线程。

参数

aGroundId	群组 ID。
pError	错误信息。

返回

搜索到的群组␈。

取消屏蔽群消息。

参数

aGroupId	要取消屏蔽的群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

取消屏蔽群消息

同步方法，会阻塞当前线程。

参数

aGroupId	要取消屏蔽的群组 ID。
pError	错误信息。

返回

群组实例。

从群组黑名单中移除。

该方法只有群主才有权限调用。

参数

aMembers	要从黑名单中移除的用户名列表。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

从群组黑名单中移除。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aOccupants	要从黑名单中移除的用户名列表。
aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

解除全员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

解除全员禁言。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
pError	错误信息。

返回

群组实例。

解除禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aMuteMembers	被解除禁言的用户列表。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

解除禁言。

该方法只有管理员或者群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aMuteMembers	被解除禁言的用户列表。
aGroupId	群组 ID。
pError	错误信息。

返回

返回群组实例。

更改群组说明信息。

该方法只有群主才有权限调用。

参数

aDescription	说明信息。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

修改群公告。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数

aGroupId	群组 ID。
aAnnouncement	群公告。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

修改群公告。

该方法只有管理员或者群主才有权限调用。

参数

aGroupId	群组 ID。
aAnnouncement	群公告。
pError	错误信息。

返回

群组实例。

修改群扩展信息。

该方法只有群主才有权限调用。

参数

aGroupId	群组 ID。
aExt	扩展信息。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

修改群扩展信息。

该方法只有群主才有权限调用。

参数

aGroupId	群组 ID。
aExt	扩展信息
pError	错误信息。

返回

群组实例。

改变群主。

该方法只有群主才有权限调用。

参数

aGroupId	群组 ID。
aNewOwner	新群主。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

改变群主。

该方法只有群主才有权限调用。

同步方法，会阻塞当前线程。

参数

aGroupId	群组 ID。
aNewOwner	新群主。
pError	错误信息。

返回

返回群组实例。

更改群组主题 。

该方法只有群主才有权限调用。

参数

aSubject	新主题。
aGroupId	群组 ID。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

屏蔽/取消屏蔽群组消息的推送。

已废弃，请用 IAgoraChatPushManager::updatePushServiceForGroups:disablePush:completion: 代替。

参数

aGroupId	群组 ID。
aIsEnable	是否允许推送。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

屏蔽/取消屏蔽群组消息的推送。

已废弃，请用 IAgoraChatPushManager::updatePushServiceForGroups:disablePush:completion: 代替。

参数

aGroupIDs	群组 ID 列表。
aIsEnable	是否允许推送。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

上传群共享文件。

参数

aGroupId	群组 ID。
aFilePath	文件路径。
pError	错误信息。

返回

群组实例。