LVIMMessage Class Reference

Inherits from NSObject
Declared in LVIMMessage.h
LVIMMessage.mm

Other Methods

+ fromJsonDictory:

从json转化

+ (LVIMMessage *)fromJsonDictory:(NSDictionary *)json

Parameters

json

内容

Return Value

失败返回nil *

Declared In

LVIMMessage.h

+ fromProtobufMessage:

从pb消息转化

+ (LVIMMessage *)fromProtobufMessage:(const void *)msg

Parameters

msg

pb消息(const IMMessage*)

Return Value

失败返回nil *

Declared In

LVIMMessage.h

+ fromLocalDatabase:

从本地数据库结构初始化

+ (LVIMMessage *)fromLocalDatabase:(void *)data

Parameters

data

数据

Return Value

失败返回nil *

Declared In

LVIMMessage.h

– invalid

检测必要属性是否无效 *

- (BOOL)invalid

Declared In

LVIMMessage.h

– isInvalidSize

检测消息大小是否超标

- (int)isInvalidSize

Return Value

超长返回非0, 未超长返回0 *

Declared In

LVIMMessage.h

– isInvalidRequestParams

检测发送请求的参数是否无效 *

- (int)isInvalidRequestParams

Declared In

LVIMMessage.h

– isAckMessage

是否是回执 *

- (BOOL)isAckMessage

Declared In

LVIMMessage.h

– isChatroomMessage

是否是直播间消息 *

- (BOOL)isChatroomMessage

Declared In

LVIMMessage.h

– isPrivateMessage

是否是私信消息 *

- (BOOL)isPrivateMessage

Declared In

LVIMMessage.h

– isGroupMessage

是否是群组消息 *

- (BOOL)isGroupMessage

Declared In

LVIMMessage.h

– isSystemMessage

是否是系统消息 *

- (BOOL)isSystemMessage

Declared In

LVIMMessage.h

– isTextMessageContent

内容是否是图片(私信/群组) *

- (BOOL)isTextMessageContent

Declared In

LVIMMessage.h

– isImageMessageContent

内容是否是图片(私信/群组) *

- (BOOL)isImageMessageContent

Declared In

LVIMMessage.h

– isAudioMessageContent

内容是否是音频(私信/群组) *

- (BOOL)isAudioMessageContent

Declared In

LVIMMessage.h

– isVideoMessageContent

内容是否是视频(私信/群组) *

- (BOOL)isVideoMessageContent

Declared In

LVIMMessage.h

– getMessageStringType

获取消息类型

- (NSString *)getMessageStringType

Return Value

失败返回nil *

Declared In

LVIMMessage.h

– getMessageStringContent

获取消息内容

- (NSString *)getMessageStringContent

Return Value

失败返回nil *

Declared In

LVIMMessage.h

– buildChatroomRequest:tid:type:content:

构建房间请求消息

- (int)buildChatroomRequest:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content

Parameters

fid

发送者ID(用户ID)

tid

接收者ID(房间ID)

type

消息类型别名(类型唯一)

content

消息内容

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

– buildPrivateRequest:fid:tid:type:content:pushTitle:pushContent:extend3:extend4:targetAppID:targetAppUID:

构建私信请求

- (int)buildPrivateRequest:(int)subType fid:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4 targetAppID:(NSString *)targetAppID targetAppUID:(NSString *)targetAppUID

Parameters

subType

内容类型(见LVIM_MESSAGE_SUBTYPE)

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

targetAppID

扩展字段5(目标应用ID)

targetAppUID

扩展字段6(目标应用UID)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

– buildTextPrivateRequest:tid:type:content:pushTitle:pushContent:extend3:extend4:targetAppID:targetAppUID:

构建文本私信请求

- (int)buildTextPrivateRequest:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4 targetAppID:(NSString *)targetAppID targetAppUID:(NSString *)targetAppUID

Parameters

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

targetAppID

扩展字段5(目标应用ID)

targetAppUID

扩展字段6(目标应用UID)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

– buildImagePrivateRequest:tid:type:content:pushTitle:pushContent:extend3:extend4:targetAppID:targetAppUID:

构建图片私信请求

- (int)buildImagePrivateRequest:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4 targetAppID:(NSString *)targetAppID targetAppUID:(NSString *)targetAppUID

Parameters

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

targetAppID

扩展字段5(目标应用ID)

targetAppUID

扩展字段6(目标应用UID)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

– buildVideoPrivateRequest:tid:type:content:pushTitle:pushContent:extend3:extend4:targetAppID:targetAppUID:

构建视频私信请求

- (int)buildVideoPrivateRequest:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4 targetAppID:(NSString *)targetAppID targetAppUID:(NSString *)targetAppUID

Parameters

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

targetAppID

扩展字段5(目标应用ID)

targetAppUID

扩展字段6(目标应用UID)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

– buildGroupRequest:fid:tid:type:content:pushTitle:pushContent:extend3:extend4:

构建私信请求

- (int)buildGroupRequest:(int)subType fid:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4

Parameters

subType

内容类型(见LVIM_MESSAGE_SUBTYPE)

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h

+ buildChatRoomTextMessage:toid:uname:content:

构建一条直播间聊天消息

+ (LVIMMessage *)buildChatRoomTextMessage:(NSString *)fromid toid:(NSString *)toid uname:(NSString *)uname content:(NSString *)content

Parameters

fromid

发送者ID

toid

接收者ID(房间ID)

uname

发送者名称

content

聊天内容

Return Value

失败返回nil *

Declared In

LVIMMessage.h

Other Methods

– buildAudioPrivateRequest:tid:type:content:pushTitle:pushContent:extend3:extend4:targetAppID:targetAppUID:

构建音频私信请求

- (int)buildAudioPrivateRequest:(NSString *)fid tid:(NSString *)tid type:(NSString *)type content:(NSString *)content pushTitle:(NSString *)pushTitle pushContent:(NSString *)pushContent extend3:(NSString *)extend3 extend4:(NSData *)extend4 targetAppID:(NSString *)targetAppID targetAppUID:(NSString *)targetAppUID

Parameters

fid

发送者ID(用户ID)

tid

接收者ID(用户ID)

type

消息类型别名(类型唯一)

content

消息内容

pushTitle

推送标题

pushContent

推送内容

extend3

扩展字段(字符串:无特殊情况不要使用)

extend4

扩展字段(二进制:无特殊情况不要使用)

targetAppID

扩展字段5(目标应用ID)

targetAppUID

扩展字段6(目标应用UID)

Return Value

成功返回0, 否则返回非0 *

Declared In

LVIMMessage.h