|
HyphenateSDK
3.3.0
|
#import <EMClient.h>
类方法 | |
| (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 |
| - ("Use -migrateDatabaseToLatestSDK") __deprecated_msg |
iOS专用,数据迁移到SDK3.0
同步方法,会阻塞当前线程
升级到SDK3.0版本需要调用该方法,开发者需要等该方法执行完后再进行数据库相关操作
| - (void) addDelegate: | (3_1_0) | ||
| (3_2_2) | |||
| ("Use -") | EM_DEPRECATED_IOS[IEMCallManager addDelegate:delegateQueue:] | ||
添加回调代理
| aDelegate | 要添加的代理 |
| - (void) addDelegate: | (id< EMClientDelegate >) | aDelegate | |
| delegateQueue: | (dispatch_queue_t) | aQueue | |
添加回调代理
| aDelegate | 要添加的代理 |
| aQueue | 执行代理方法的队列 |
| - (void) application: | (id) | application | |
| didReceiveRemoteNotification: | (NSDictionary *) | userInfo | |
iOS专用,程序在前台收到APNs时,需要调用此方法
| application | UIApplication |
| userInfo | 推送内容 |
| - (void) applicationDidEnterBackground: | (id) | aApplication |
iOS专用,程序进入后台时,需要调用此方法断开连接
| aApplication | UIApplication |
| - (void) applicationWillEnterForeground: | (id) | aApplication |
iOS专用,程序进入前台时,需要调用此方法进行重连
| aApplication | UIApplication |
| - (void) asyncBindDeviceToken: | (NSData *) | aDeviceToken | |
| success: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -registerForRemoteNotificationsWithDeviceToken:completion:") | __deprecated_msg | |
绑定device token
| aDeviceToken | 要绑定的token |
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncGetPushOptionsFromServer: | (void(^)(EMPushOptions *aOptions)) | aSuccessBlock | |
| failure: | ("Use -getPushOptionsFromServerWithCompletion:") | __deprecated_msg | |
从服务器获取推送属性
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncLoginWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
| success: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -loginWithUsername:password:completion") | __deprecated_msg | |
登录
| aUsername | 用户名 |
| aPassword | 密码 |
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncLogout: | (BOOL) | aIsUnbindDeviceToken | |
| success: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -logout:completion:") | __deprecated_msg | |
退出
| aIsUnbindDeviceToken | 是否解除device token的绑定,解除绑定后设备不会再收到消息推送 如果传入YES, 解除绑定失败,将返回error |
| - (void) asyncRegisterWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
| success: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -registerWithUsername:password:completion:") | __deprecated_msg | |
注册用户
不推荐使用,建议后台通过REST注册
| aUsername | 用户名 |
| aPassword | 密码 |
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncSetApnsNickname: | (NSString *) | aNickname | |
| success: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -updatePushNotifiationDisplayName:copletion") | __deprecated_msg | |
设置推送消息显示的昵称
| aNickname | 要设置的昵称 |
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncUpdatePushOptionsToServer: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -updatePushNotificationOptionsToServerWithCompletion:") | __deprecated_msg | |
更新推送设置到服务器
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (void) asyncUploadLogToServer: | (void(^)()) | aSuccessBlock | |
| failure: | ("Use -uploadDebugLogToServerWithCompletion:") | __deprecated_msg | |
上传日志到服务器
| aSuccessBlock | 成功的回调 |
| aFailureBlock | 失败的回调 |
| - (EMError *) bindDeviceToken: | (NSData *) | aDeviceToken |
绑定device token
同步方法,会阻塞当前线程
| aDeviceToken | 要绑定的token |
| - (NSString *) getLogFilesPath: | (EMError **) | pError |
将日志文件压缩成.gz文件,返回gz文件路径。强烈建议方法完成之后删除该压缩文件
同步方法,会阻塞当前线程
| pError | 错误信息 |
| - (void) getLogFilesPathWithCompletion: | (void(^)(NSString *aPath, EMError *aError)) | aCompletionBlock |
将日志文件压缩成.gz文件,返回gz文件路径。强烈建议方法完成之后删除该压缩文件
| aCompletionBlock | 完成的回调 |
| - (void) getPushNotificationOptionsFromServerWithCompletion: | (void(^)(EMPushOptions *aOptions, EMError *aError)) | aCompletionBlock |
从服务器获取推送属性
| aCompletionBlock | 完成的回调 |
| - (EMPushOptions *) getPushOptionsFromServerWithError: | (EMError **) | pError |
从服务器获取推送属性
同步方法,会阻塞当前线程
| pError | 错误信息 |
| - (EMError *) loginWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
登录
同步方法,会阻塞当前线程
| aUsername | 用户名 |
| aPassword | 密码 |
| - (void) loginWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
| completion: | (void(^)(NSString *aUsername, EMError *aError)) | aCompletionBlock | |
登录
| aUsername | 用户名 |
| aPassword | 密码 |
| aCompletionBlock | 完成的回调 |
| - (EMError *) logout: | (BOOL) | aIsUnbindDeviceToken |
退出
同步方法,会阻塞当前线程
| aIsUnbindDeviceToken | 是否解除device token的绑定,解除绑定后设备不会再收到消息推送 如果传入YES, 解除绑定失败,将返回error |
| - (void) logout: | (BOOL) | aIsUnbindDeviceToken | |
| completion: | (void(^)(EMError *aError)) | aCompletionBlock | |
退出
| aIsUnbindDeviceToken | 是否解除device token的绑定,解除绑定后设备不会再收到消息推送 如果传入YES, 解除绑定失败,将返回error |
| aCompletionBlock | 完成的回调 |
| - (BOOL) migrateDatabaseToLatestSDK |
iOS专用,数据迁移到SDK3.0
同步方法,会阻塞当前线程
升级到SDK3.0版本需要调用该方法,开发者需要等该方法执行完后再进行数据库相关操作
| - (void) registerForRemoteNotificationsWithDeviceToken: | (NSData *) | aDeviceToken | |
| completion: | (void(^)(EMError *aError)) | aCompletionBlock | |
绑定device token
| aDeviceToken | 要绑定的token |
| aCompletionBlock | 完成的回调 |
| - (EMError *) registerWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
注册用户
同步方法,会阻塞当前线程. 不推荐使用,建议后台通过REST注册
| aUsername | 用户名 |
| aPassword | 密码 |
| - (void) registerWithUsername: | (NSString *) | aUsername | |
| password: | (NSString *) | aPassword | |
| completion: | (void(^)(NSString *aUsername, EMError *aError)) | aCompletionBlock | |
注册用户
不推荐使用,建议后台通过REST注册
| aUsername | 用户名 |
| aPassword | 密码 |
| aCompletionBlock | 完成的回调 |
| - (void) removeDelegate: | (id) | aDelegate |
移除回调代理
| aDelegate | 要移除的代理 |
| - (EMError *) setApnsNickname: | (NSString *) | aNickname |
设置推送消息显示的昵称
同步方法,会阻塞当前线程
| aNickname | 要设置的昵称 |
| + (instancetype) sharedClient |
获取SDK实例
| - (void) updatePushNotifiationDisplayName: | (NSString *) | aDisplayName | |
| completion: | (void(^)(NSString *aDisplayName, EMError *aError)) | aCompletionBlock | |
设置推送的显示名
| aDisplayName | 推送显示名 |
| aCompletionBlock | 完成的回调 |
| - (void) updatePushNotificationOptionsToServerWithCompletion: | (void(^)(EMError *aError)) | aCompletionBlock |
更新推送设置到服务器
| aCompletionBlock | 完成的回调 |
| - (EMError *) updatePushOptionsToServer |
更新推送设置到服务器
同步方法,会阻塞当前线程
| - (void) uploadDebugLogToServerWithCompletion: | (void(^)(EMError *aError)) | aCompletionBlock |
上传日志到服务器
| aCompletionBlock | 完成的回调 |
| - (EMError *) uploadLogToServer |
上传日志到服务器
同步方法,会阻塞当前线程
|
readnonatomicstrong |
实时通讯模块
由 category EMClient(Call) 提供.
|
readnonatomicstrong |
聊天模块
|
readnonatomicstrong |
好友模块
|
readnonatomicstrong |
当前登录账号
|
readnonatomicstrong |
群组模块
|
readnonatomicassign |
SDK是否自动登录上次登录的账号
|
readnonatomicassign |
是否连上聊天服务器
|
readnonatomicassign |
用户是否已登录
|
readnonatomicstrong |
SDK属性
|
readnonatomicstrong |
推送设置
|
readnonatomicstrong |
聊天室模块
|
readnonatomicstrong |
SDK版本号
1.8.11