#import <IEMPresenceManager.h>
@header IEMPresenceManager.h @abstract 在线状态管理类,负责发布自定义在线状态、管理在线状态订阅、查询指定用户的在线状态以及添加和移除回调代理。
- 作者
- Hyphenate
- 版本
- 3.00
在线状态管理协议,提供在线状态管理功能。
◆ addDelegate:delegateQueue:
- (void) addDelegate: |
|
(id< EMPresenceManagerDelegate > _Nonnull) |
aDelegate |
delegateQueue: |
|
(dispatch_queue_t _Nullable) |
aQueue |
|
|
| |
添加回调代理。
- 参数
-
aDelegate | 要添加的代理。 |
aQueue | 执行代理方法的队列。若要在主线程上运行应用,需将该参数设置为空。 |
◆ fetchPresenceStatus:completion:
- (void) fetchPresenceStatus: |
|
(NSArray< NSString * > *_Nonnull) |
members |
completion: |
|
(void(^)(NSArray< EMPresence * > *_Nullable presences, EMError *_Nullable error)) |
aCompletion |
|
|
| |
查询指定用户的当前在线状态。
- 参数
-
members | 用户 ID 数组,指定要查询哪些用户的在线状态。 |
aCompletion | 完成回调,返回用户的在线状态。 |
◆ fetchSubscribedMembersWithPageNum:pageSize:Completion:
- (void) fetchSubscribedMembersWithPageNum: |
|
(NSUInteger) |
pageNum |
pageSize: |
|
(NSUInteger) |
pageSize |
Completion: |
|
(void(^)(NSArray< NSString * > *_Nullable members, EMError *_Nullable error)) |
aCompletion |
|
|
| |
分页查询当前用户订阅了哪些用户的在线状态。
- 参数
-
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页的订阅用户的数量,最大不能超过500。 |
aCompletion | 完成回调,返回订阅的在线状态所属的用户 ID。若当前未订阅任何用户的在线状态,返回空值。 |
◆ publishPresenceWithDescription:completion:
- (void) publishPresenceWithDescription: |
|
(NSString *_Nullable) |
aDescription |
completion: |
|
(void(^)(EMError *_Nullable error)) |
aCompletion |
|
|
| |
发布自定义在线状态。
- 参数
-
aDescription | 在线状态详细信息,建议不超过64字节。 |
aCompletion | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ removeDelegate:
◆ subscribe:expiry:completion:
- (void) subscribe: |
|
(NSArray< NSString * > *_Nonnull) |
members |
expiry: |
|
(NSInteger) |
expiry |
completion: |
|
(void(^)(NSArray< EMPresence * > *_Nullable presences, EMError *_Nullable error)) |
aCompletion |
|
|
| |
订阅指定用户的在线状态。订阅成功后,在线状态变更时订阅者会收到回调通知。
- 参数
-
members | 要订阅Presence的用户 ID 数组,数组长度不能超过100。 |
expiry | 订阅持续时间,单位为秒,最大不超过30*24*3600。 |
aCompletion | 该方法完成调用的回调。如果该方法调用成功,会返回订阅用户的当前状态,调用失败,会包含调用失败的原因。 |
◆ unsubscribe:completion:
- (void) unsubscribe: |
|
(NSArray< NSString * > *_Nonnull) |
members |
completion: |
|
(void(^)(EMError *_Nullable error)) |
aCompletion |
|
|
| |
取消订阅指定用户的在线状态。
- 参数
-
members | 要取消订阅Presence的用户 ID 数组,数组长度不能超过100。 |
aCompletion | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
该协议的文档由以下文件生成: