ProtocalFactory Class Reference

Inherits from NSObject
Declared in ProtocalFactory.h

Overview

MibileIMSDK框架的协议工厂类。

理论上这些协议都是即时通讯框架内部要用到的，上层应用可以无需理解和理会之。

@author Jack Jiang(http://www.52im.net/thread-2792-1-1.html))

+ parse:

将JSON转换而来的byte数组反序列化成Protocal类的对象.

本方法主要由MobileIMSDK框架内部使用。

+ (id)parse:(NSData *)fullProtocalJASOnBytes

Parameters

fullProtocalJASOnBytes

JSON转换而来的byte数组

Return Value

如果返回列化成功则返回对象，否则返回nil

Discussion

将JSON转换而来的byte数组反序列化成Protocal类的对象.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ parse:withClass:

将JSON转换而来的byte数组反序列化成指定类的对象.

本方法主要由MobileIMSDK框架内部使用。

+ (id)parse:(NSData *)fullProtocalJASOnBytes withClass:(Class)clazz

Parameters

fullProtocalJASOnBytes

JSON转换而来的byte数组
clazz

类

Return Value

如果返回列化成功则返回对象，否则返回nil

Discussion

将JSON转换而来的byte数组反序列化成指定类的对象.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ parseObject:withClass:

将指定的JSON字符串反序列化成指定类的对象.

本方法主要由MobileIMSDK框架内部使用。

+ (id)parseObject:(NSString *)dataContentJSONOfProtocal withClass:(Class)clazz

Parameters

dataContentJSONOfProtocal

json字符串
clazz

类

Return Value

如果返回列化成功则返回对象，否则返回nil

Discussion

将指定的JSON字符串反序列化成指定类的对象.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ parsePLoginInfoResponse:

接收用户登陆响应消息对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

+ (PLoginInfoResponse *)parsePLoginInfoResponse:(NSString *)dataContentOfProtocal

Discussion

接收用户登陆响应消息对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

@param dataContentOfProtocal @return

Declared In

ProtocalFactory.h

+ parsePErrorResponse:

解析错误响应消息对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

+ (PErrorResponse *)parsePErrorResponse:(NSString *)dataContentOfProtocal

Discussion

解析错误响应消息对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

@param dataContentOfProtocal @return

Declared In

ProtocalFactory.h

+ parsePKickoutInfo:

解析用户被踢消息报文对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

+ (PKickoutInfo *)parsePKickoutInfo:(NSString *)dataContentOfProtocal

Discussion

解析用户被踢消息报文对象（该对象由客户端接收）.

本方法主要由MobileIMSDK框架内部使用。

@param dataContentOfProtocal @return

Declared In

ProtocalFactory.h

+ createPLoginoutInfo:

创建用户注消登陆消息对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createPLoginoutInfo:(NSString *)user_id

Return Value

新建的 Protocal 报文对象

Discussion

创建用户注消登陆消息对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

@param user_id @param loginName

Declared In

ProtocalFactory.h

+ createPLoginInfo:

创建用户登陆消息对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createPLoginInfo:(PLoginInfo *)loginInfo

Parameters

loginInfo

登陆信息对象，详见：http://docs.52im.net/extend/docs/api/mobileimsdk/server_tcp/net/x52im/mobileimsdk/server/protocal/c/PLoginInfo.html

Return Value

新建的 Protocal 报文对象

Discussion

创建用户登陆消息对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createPKeepAlive:

创建用户心跳包对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createPKeepAlive:(NSString *)from_user_id

Return Value

新建的 Protocal 报文对象

Discussion

创建用户心跳包对象（该对象由客户端发出）.

本方法主要由MobileIMSDK框架内部使用。

@param from_user_id

Declared In

ProtocalFactory.h

+ createCommonData:fromUserId:toUserId:

通用消息的Protocal对象新建方法（默认不需要Qos支持）。

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createCommonData:(NSString *)dataContent fromUserId:(NSString *)from_user_id toUserId:(NSString *)to_user_id

Parameters

dataContent

要发送的数据内容（字符串方式组织）
from_user_id

发送人的user_id
to_user_id

接收人的user_id

Return Value

新建的 Protocal 报文对象

Discussion

通用消息的Protocal对象新建方法（默认不需要Qos支持）。

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createCommonData:fromUserId:toUserId:withTypeu:

通用消息的Protocal对象新建方法（默认不需要Qos支持）。

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createCommonData:(NSString *)dataContent fromUserId:(NSString *)from_user_id toUserId:(NSString *)to_user_id withTypeu:(int)typeu

Parameters

dataContent

要发送的数据内容（字符串方式组织）
from_user_id

发送人的user_id
to_user_id

接收人的user_id

Return Value

新建的Protocal对象

Discussion

通用消息的Protocal对象新建方法（默认不需要Qos支持）。

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createCommonData:fromUserId:toUserId:qos:fp:withTypeu:

通用消息的Protocal对象新建方法。

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createCommonData:(NSString *)dataContent fromUserId:(NSString *)from_user_id toUserId:(NSString *)to_user_id qos:(bool)QoS fp:(NSString *)fingerPrint withTypeu:(int)typeu

Parameters

dataContent

要发送的数据内容（字符串方式组织）
from_user_id

发送人的user_id
to_user_id

接收人的user_id
QoS

是否需要QoS支持，true表示需要，否则不需要
fingerPrint

消息指纹特征码，为nil则表示由系统自动生成指纹码，否则使用本参数指明的指纹码

Return Value

新建的 Protocal 报文对象

Discussion

通用消息的Protocal对象新建方法。

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createRecivedBack:toUserId:withFingerPrint:

客户端from_user_id向to_user_id发送一个QoS机制中需要的“收到消息应答包” (bridge标识默认为false).

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createRecivedBack:(NSString *)from_user_id toUserId:(NSString *)to_user_id withFingerPrint:(NSString *)recievedMessageFingerPrint

Parameters

from_user_id

发起方
to_user_id

接收方
recievedMessageFingerPrint

已收到的消息包指纹码

Return Value

新建的 Protocal 报文对象

Discussion

客户端from_user_id向to_user_id发送一个QoS机制中需要的“收到消息应答包” (bridge标识默认为false).

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createRecivedBack:toUserId:withFingerPrint:andBridge:

客户端from_user_id向to_user_id发送一个QoS机制中需要的“收到消息应答包”.

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createRecivedBack:(NSString *)from_user_id toUserId:(NSString *)to_user_id withFingerPrint:(NSString *)recievedMessageFingerPrint andBridge:(bool)bridge

Parameters

from_user_id

发起方
to_user_id

接收方
recievedMessageFingerPrint

已收到的消息包指纹码

Return Value

新建的 Protocal 报文对象

Discussion

客户端from_user_id向to_user_id发送一个QoS机制中需要的“收到消息应答包”.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h

+ createPKickout:code:reason:

创建用户被踢包报文对象（该对象由服务端发出）.

本方法主要由MobileIMSDK框架内部使用。

+ (Protocal *)createPKickout:(nonnull NSString *)to_user_id code:(int)code reason:(nullable NSString *)reason

Parameters

to_user_id

接收方
code

被踢原因编码（本参数不可为空），see {@link PKickoutInfo} 中的常量定义，自定义被踢原因请使用>100的值
reason

被踢原因描述（本参数可为空）

Return Value

新建的{@link Protocal}报文对象

Availability

6.0

Discussion

创建用户被踢包报文对象（该对象由服务端发出）.

本方法主要由MobileIMSDK框架内部使用。

Declared In

ProtocalFactory.h