SSE-SDK-iOS: An Objective-C repository from guobihai

Swaiot开放平台下推送SDK库

iOS-SDK及demo下载地址

安装方式

1 在开放平台上获得分配到的Swaiot开发者appkey和saltkey;
2 在工程的Frameworks目录中拖入SSELib.framework（合并了真机和虚拟机的framework） ;
3 在工程配置的Build Settings 分支下的Other Linker Flags当中增加如下:

   -lObjC
   -lc++

4 在工程共层代码的Info.plist中增加键值对:

key: SSEAPPKEY  value: swaiot开放平台分配到的APPKEY

5 实现的委托监听,在监听代码中的实现接口中填如saltkey．

/**
 FIXME:
      从swaiot开放平台获得的APPEKY和APPSALT，其中APPKEY填到info.plist当中增加：SSEAPPKEY并填入值
            此处填入APPSALT
 */
-(NSString*) saltOfSSETunnel{
    return @"";
}

详细可见下载地址中的sselibtest工程的配置及代码说明.

API说明

SSEManager 类API

/**
 单例
 */
+ (instancetype)sharedInstance;

/**
  SDK自动生成uuid作为唯一标识，接入SSE平台，
  该接口主要用于第三方开放平台下载的APP，uid会保存在本地
 */
-(bool) connect_sse;

/**
   如果是自动生成的UUID，重连逻辑请调用该接口
 */
-(bool) reConnect_sse;

/**
    获得SDK生成的唯一的设备ID
 */
-(NSString*) readUniqueID;

/*
 * 连接SSE平台
 * 标准接口，需要根据业务需要传递唯一的ID，为防止冲突，可以增加业务前缀
 * @param did： 业务唯一ID
 * @return true： 成功 false： 失败
 */
-(bool)connect_sse:(NSString*)did

/**
 *  重连SSE平台，
 *  在设备发生网络状态变化，或者设备唯一ID发生变化的时候，可以调用
 * @param did ：业务接入SSE的唯一ID
 * @return true：成功  false： 失败
 */
-(bool) reConnect_sse:(NSString*)did

/*
 * 以智慧屏的方式接入SSE
 * 智慧屏接入方式相比connect_sse接口，云端会增加智慧屏的好友设备列表推送在离线的设备状态消息，以及智慧屏相关业务的其他消息推送
 * 该方法用户智慧屏的相关业务，主要在酷开系统8.x以及有ScreenID关系的设备上，其他第三方请勿使用
 * @param screenID:智慧屏唯一ID
 * @return true：成功 false：失败
 */
-(bool) connect_sse_ASSmartScreen:(NSString*) screenID

/*
 * 重新连接SSE平台
 * 在设备上，如果网络状态发生变化，或者ScreenID发生了变化，需要重新调用接口
 * @param screenID：智慧屏ID
 * @return true：成功 false：失败
 */
-(bool) reConnect_sse_ASSmartScreen:(NSString*) screenID

/*
* 以Swaiot-SSE的方式接入SSE
* 该接口相比于connect_sse的接口，云端会增加用户账号下其他IOT设备状态变化的推送
* @param did: 设备作为iot设备的唯一id
* @param accessToken：从酷开账号中心获得的用户授权令牌
* @param useId：从酷开账号中心获得的用户uid
* @return true：成功 false：失败
*/
-(bool) connect_sse_ASIotDevice:(NSString*)did accessToken:(NSString*)userAk userId:(NSString*)uid;

/*
 * 以Swaiot-IOT设备的方式重新接入SSE平台
 * 在设备上，如果网络状态发生变化，或者ScreenID发生了变化，需要重新调用接口
 * @param did:设备唯一id
 * @param accessToken：从酷开账号中心获得的用户授权令牌
 * @param useId：从酷开账号中心获得的用户uid
 * @return true：成功 false：失败
 *
 */
-(bool) reconnect_see_ASIotDevice:(NSString*)did accessToken:(NSString*)userAk userId:(NSString*)uid;

/**
     * 发送消息给其他设备
     * @param destDid 发送到的设备ｉd
     * @param mid 发送的消息ｉｄ
     * @param msgName 发送的消息名称
     * @param msg 发送的消息
     * @return true 成功加入发送队列，false 加入发送队列失败
     */
-(bool) sendMessage:(NSString*)destDid msgId:(NSString*)mid msgName:(NSString*)msgName msg:(NSString*)msg;

/**
     * 该接口为异步接口，可以同时发给多个设备不同的文件。
     * 发送过程由onSendFileToCloud 进行回调
     * @param destDid 发送文件给到的目标设备id
     * @param filePath 要发送的文件的本地路径地址
     * @param uid，用来标识文件上传方的id，建议传入connectSSE方法的did参数．
     */
-(void) syncFileToCloud:(NSString*)destDid file:(NSString*)filePath uid:(NSString*)uid;

/**
     * 从云端同步文件，该接口为异步接口，可同时同步多个文件
     * @param fileKey onSendFileToCloud 完成时候，回调的fileKey
	 * 该fileKey是发送方调用syncFileToCloud之后接受到的消息，然后发送方再调用sendMessage接口将fileKey传递给消息接收方，接收方完成文件下载．会将文件存储于应用纱盒的cache目录
     */
-(void) syncFileFromCloud:(NSString*)fileKey;

/**
     * @return true SSE已经连接成功,false 失败
     */
-(bool) isSSEStarted;

@protocol SSELibDelegate 回调API

/**
 调用了[[SSEManager sharedInstance]syncFileToCloud:]发发之后的异步回调
 发送文件到bos存储服务，发送过程是异步的，发送成功/失败都会回调到函数。
 @param sendResule 文件上传结果
 SENDFILE_ERROR = -1, //发送失败了
 SENDFILE_ONPROGRESS = 0, //发送的进度回调
 SENDFILE_FINISHED=1,//发送完成了
 @param fileKey 文件上传标识
 */
-(void) onSendFileToCloud:(SendFileResult)sendResule fileKey:(NSString*)fileKey destDId:(NSString*) destDId progress:(NSNumber*)progress error:(NSError*)err

/**
 调用了[[SSEManager sharedInstance]syncFileFromCloud:]之后的异步回调
 从bos存储服务下载文件的过程，下载过程是异步的，接收成功/失败都会回调到函数。
 @param receivedResult 文件下载结果
 RECEIVEFILE_ERROR = -1, //下载文件失败了
 RECEIVEFILE_ONPROGRESS = 0, //下载文件的进度回调
 SENDFILE_FINISHED=1,//下载文件完成了
 @param fileKey 文件在bos上的唯一标识
 @param savedUrl 文件下载到本地的路径地址
 @param err 文件下载错误信息
 */
-(void) onReceivedFileFromCloud:(ReceivedFileResult)receivedResult fileKey:(NSString*)fileKey savedPath:(NSString*)savedUrl progress:(NSNumber*)progress error:(NSError*)err;

/**
 FIXME:
      从swaiot开放平台获得的APPEKY和APPSALT，其中APPKEY填到info.plist当中增加：SSEAPPKEY并填入值
            此处填入APPSALT
 */
-(NSString*) saltOfSSETunnel;

/**
 SSELib库的错误回调
 @param errorCode 错误code
 ConnectHostFail =0,  //连不上服务器错误
 SSEDisconnect =1,  //服务器断开连接错误
 SSESendError = 2, //发送失败错误
 ConnectBosHostFail = 3, //获取bos地址错误
 @param errMsg 库错误消息
 
 */
-(void) onSSEError:(SSEConnectError)errorCode errString:(NSString*) errMsg ;

/**
 SSE连接成功之后的回调
 */
-(void) onSSETunnelStarted  ;

/**
 接收到其他设备、或者其他服务器推送过来的消息
 @param msgId  唯一设备消息id
 @param eventName 消息名称
 @param message 消息数据
 */
-(void) onReceiveSSEMessage:(NSString*)msgId msgName:(NSString*) eventName msg:(NSString*)message ;

/**
 调用[[SSEManager sharedInstance] sendMessage]结果的回调
 @param resultCode 发送结果
 TARGETOFFLINEERROR = 0,  //发送失败，发生了错误
 TARGETONLINESUCCESS =1,
 @param dest 发送到的目标id
 @param messageId 发送的消息序列号id
 @param eventName 发送的消息名称
 @param message 发送的消息内容
 */
-(void) onSendSSEResult:(SSESendResult) resultCode destStr:(NSString*)dest msgId:(NSString*)messageId msgName:(NSString*) eventName msg:(NSString*)message;

guobihai/SSE-SDK-iOS

Swaiot开放平台下推送SDK库

iOS-SDK及demo下载地址

安装方式

API说明

SSEManager 类API

@protocol SSELibDelegate 回调API