HyphenateSDK
3.1.4
|
#import <EMClient.h>
构造函数 | |
(void) | - addDelegate:delegateQueue: |
(void) | - removeDelegate: |
(EMError *) | - initializeSDKWithOptions: |
(EMError *) | - registerWithUsername:password: |
(EMError *) | - loginWithUsername:password: |
(EMError *) | - logout: |
(EMError *) | - bindDeviceToken: |
(EMError *) | - setApnsNickname: |
(EMPushOptions *) | - getPushOptionsFromServerWithError: |
(EMError *) | - updatePushOptionsToServer |
(EMError *) | - uploadLogToServer |
(void) | - asyncRegisterWithUsername:password:success:failure: |
(void) | - asyncLoginWithUsername:password:success:failure: |
(void) | - asyncLogout:success:failure: |
(void) | - asyncBindDeviceToken:success:failure: |
(void) | - asyncSetApnsNickname:success:failure: |
(void) | - asyncGetPushOptionsFromServer:failure: |
(void) | - asyncUpdatePushOptionsToServer:failure: |
(void) | - asyncUploadLogToServer:failure: |
(BOOL) | - dataMigrationTo3 |
(void) | - applicationDidEnterBackground: |
(void) | - applicationWillEnterForeground: |
类方法 | |
(instancetype) | + sharedClient |
Protected 属性 | |
EMPushOptions * | _pushOptions |
属性 | |
NSString * | version |
NSString * | currentUsername |
EMOptions * | options |
EMPushOptions * | pushOptions |
id< IEMChatManager > | chatManager |
id< IEMContactManager > | contactManager |
id< IEMGroupManager > | groupManager |
id< IEMChatroomManager > | roomManager |
BOOL | isAutoLogin |
BOOL | isLoggedIn |
BOOL | isConnected |
id< IEMCallManager > | callManager |
- (void) addDelegate: | (id< EMClientDelegate >) | aDelegate | |
delegateQueue: | (dispatch_queue_t) | aQueue | |
添加回调代理
aDelegate | 要添加的代理 |
aQueue | 执行代理方法的队列 |
- (void) applicationDidEnterBackground: | (id) | aApplication |
iOS专用,程序进入后台时,需要调用此方法断开连接
aApplication | UIApplication |
- (void) applicationWillEnterForeground: | (id) | aApplication |
iOS专用,程序进入前台时,需要调用此方法进行重连
aApplication | UIApplication |
- (void) asyncBindDeviceToken: | (NSData *) | aDeviceToken | |
success: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
绑定device token
aDeviceToken | 要绑定的token |
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncGetPushOptionsFromServer: | (void(^)(EMPushOptions *aOptions)) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
从服务器获取推送属性
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncLoginWithUsername: | (NSString *) | aUsername | |
password: | (NSString *) | aPassword | |
success: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
登录
aUsername | 用户名 |
aPassword | 密码 |
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncLogout: | (BOOL) | aIsUnbindDeviceToken | |
success: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
退出
aIsUnbindDeviceToken | 是否解除device token的绑定,解除绑定后设备不会再收到消息推送 如果传入YES, 解除绑定失败,将返回error |
- (void) asyncRegisterWithUsername: | (NSString *) | aUsername | |
password: | (NSString *) | aPassword | |
success: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
注册用户
不推荐使用,建议后台通过REST注册
aUsername | 用户名 |
aPassword | 密码 |
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncSetApnsNickname: | (NSString *) | aNickname | |
success: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
设置推送消息显示的昵称
aNickname | 要设置的昵称 |
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncUpdatePushOptionsToServer: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
更新推送设置到服务器
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (void) asyncUploadLogToServer: | (void(^)()) | aSuccessBlock | |
failure: | (void(^)(EMError *aError)) | aFailureBlock | |
上传日志到服务器
aSuccessBlock | 成功的回调 |
aFailureBlock | 失败的回调 |
- (EMError *) bindDeviceToken: | (NSData *) | aDeviceToken |
绑定device token
同步方法,会阻塞当前线程
aDeviceToken | 要绑定的token |
- (BOOL) dataMigrationTo3 |
iOS专用,数据迁移到SDK3.0
同步方法,会阻塞当前线程
升级到SDK3.0版本需要调用该方法,开发者需要等该方法执行完后再进行数据库相关操作
- (EMPushOptions *) getPushOptionsFromServerWithError: | (EMError **) | pError |
从服务器获取推送属性
同步方法,会阻塞当前线程
pError | 错误信息 |
- (EMError *) loginWithUsername: | (NSString *) | aUsername | |
password: | (NSString *) | aPassword | |
登录
同步方法,会阻塞当前线程
aUsername | 用户名 |
aPassword | 密码 |
- (EMError *) logout: | (BOOL) | aIsUnbindDeviceToken |
退出
同步方法,会阻塞当前线程
aIsUnbindDeviceToken | 是否解除device token的绑定,解除绑定后设备不会再收到消息推送 如果传入YES, 解除绑定失败,将返回error |
- (EMError *) registerWithUsername: | (NSString *) | aUsername | |
password: | (NSString *) | aPassword | |
注册用户
同步方法,会阻塞当前线程. 不推荐使用,建议后台通过REST注册
aUsername | 用户名 |
aPassword | 密码 |
- (void) removeDelegate: | (id) | aDelegate |
移除回调代理
aDelegate | 要移除的代理 |
- (EMError *) setApnsNickname: | (NSString *) | aNickname |
设置推送消息显示的昵称
同步方法,会阻塞当前线程
aNickname | 要设置的昵称 |
+ (instancetype) sharedClient |
获取SDK实例
- (EMError *) updatePushOptionsToServer |
更新推送设置到服务器
同步方法,会阻塞当前线程
- (EMError *) uploadLogToServer |
上传日志到服务器
同步方法,会阻塞当前线程
|
readnonatomicstrong |
实时通讯模块
由 category EMClient(Call) 提供.
|
readnonatomicstrong |
聊天模块
|
readnonatomicstrong |
好友模块
|
readnonatomicstrong |
当前登录账号
|
readnonatomicstrong |
群组模块
|
readnonatomicassign |
SDK是否自动登录上次登录的账号
|
readnonatomicassign |
是否连上聊天服务器
|
readnonatomicassign |
用户是否已登录
|
readnonatomicstrong |
SDK属性
|
readnonatomicstrong |
推送设置
|
readnonatomicstrong |
聊天室模块
|
readnonatomicstrong |
SDK版本号