LVIMSDK Class Reference

Inherits from	NSObject
Declared in	LVIMSDK.h LVIMSDK.mm

Other Methods

`+ sharedInstance`

获取LVIM模块的实例 *

+ (instancetype)sharedInstance

Declared In

LVIMSDK.h

`+ getUUID`

获取UUID *

+ (NSString *)getUUID

Declared In

LVIMSDK.h

`– getConfig`

获取当前的配置信息

- (LVIMConfig *)getConfig

Return Value

未设置返回nil *

Declared In

LVIMSDK.h

`– initWithAppId:secret:`

初始化

- (instancetype)initWithAppId:(NSString *)appId secret:(NSString *)secret

Parameters

`appId`	开放平台申请的appId
`secret`	开放平台申请的secret *

Declared In

LVIMSDK.h

`– setIMToken:token:`

设置LVIM的认证码

- (void)setIMToken:(NSString *)uid token:(NSString *)token

Parameters

`uid`	用户ID
`token`	认证码(lvim) *

Declared In

LVIMSDK.h

`– setPushToken:`

设置apns的推送token

- (void)setPushToken:(NSString *)token

Parameters

`token`	推送APNS的TOKEN *

Declared In

LVIMSDK.h

`– setChatroomReceiveMessageDelegate:`

设置直播间返回消息的处理代理(可根据需要设置)

- (int)setChatroomReceiveMessageDelegate:(id<LVIMReceiveMessageDelegate>)delegate

Return Value

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

Declared In

LVIMSDK.h

`– setGlobalReceiveMessageDelegate:`

设置全局返回消息的处理代理(必须设置)

- (int)setGlobalReceiveMessageDelegate:(id<LVIMReceiveMessageDelegate>)delegate

Return Value

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

Declared In

LVIMSDK.h

`– setMessageFlushDelegate:interval:`

设置消息刷新代理(可根据需要设置)

- (int)setMessageFlushDelegate:(id<LVIMReceiveMessageFlushDelegate>)delegate interval:(int32_t)interval

Parameters

`interval`	刷新间隔毫秒数

Return Value

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

Declared In

LVIMSDK.h

`– setModuleEventDelegate:`

设置模块事件代理(可根据需要设置)

- (int)setModuleEventDelegate:(id<LVIMModuleEventDelegate>)delegate

Return Value

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

Declared In

LVIMSDK.h

`– setReportDelegate:`

设置信息回报代理(可根据需要设置)

- (int)setReportDelegate:(id<LVIMReportDelegate>)delegate

Return Value

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

Declared In

LVIMSDK.h

`– setUploadLogFilterDelegate:`

设置上传日志的代理(可根据需要设置)

- (int)setUploadLogFilterDelegate:(id<LVIMUploadLogFilterDelegate>)delegate

Return Value

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

Declared In

LVIMSDK.h

`– setDebugMode:`

设置调试模式

- (int)setDebugMode:(BOOL)isEnable

Parameters

`isEnable`	是否开启调试模式 *

Declared In

LVIMSDK.h

`– setLogVisible:`

设置日志可见状态

- (int)setLogVisible:(BOOL)isVisible

Parameters

`isVisible`	日志是否可见 *

Declared In

LVIMSDK.h

`– setChatroomEnable:`

设置房间功能是否启用 *

- (int)setChatroomEnable:(BOOL)isEnable

Declared In

LVIMSDK.h

`– setPrivateEnable:`

设置私信功能是否启用 *

- (int)setPrivateEnable:(BOOL)isEnable

Declared In

LVIMSDK.h

`– setGroupEnable:`

设置群组功能是否启用 *

- (int)setGroupEnable:(BOOL)isEnable

Declared In

LVIMSDK.h

`– isStarted`

检测模块是否已经启动 *

- (BOOL)isStarted

Declared In

LVIMSDK.h

`– isConnected`

检测连接是否已经建立 *

- (BOOL)isConnected

Declared In

LVIMSDK.h

`– isAuthed`

检测认证是否完成 *

- (BOOL)isAuthed

Declared In

LVIMSDK.h

`– start`

开始运行(调用之前必须正确完成配置设置)

- (int)start

Return Value

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

Declared In

LVIMSDK.h

`– stop:`

停止运行

- (int)stop:(int)timeout

Parameters

`timeout`	等待停止运行的最大超时毫秒数

Return Value

成功停止返回1, 等待超时返回0, 否则返回<0的值 *

Declared In

LVIMSDK.h

`– login:token:guest:country:`

用户登录

- (int)login:(NSString *)uid token:(NSString *)token guest:(BOOL)guest country:(NSString *)country

Parameters

`uid`	用户ID
`token`	用户TOKEN
`guest`	游客模式
`country`	用户的国家代码

Return Value

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

Declared In

LVIMSDK.h

`– logout:waitFinishTimeout:`

用户登出

- (int)logout:(int)waitFlushTimeout waitFinishTimeout:(int)waitFinishTimeout

Parameters

`waitFlushTimeout`	等待数据同步超时毫秒数(小于等于0时不等待,默认1000)
`waitFinishTimeout`	等待完成超时毫秒数(小于等于0时不等待,默认1000)

Return Value

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

Declared In

LVIMSDK.h

`– getCacheLogPath`

获取缓存的日志路径 *

- (NSString *)getCacheLogPath

Declared In

LVIMSDK.h

`– getCacheDatabasePath`

获取缓存的数据库路径 *

- (NSString *)getCacheDatabasePath

Declared In

LVIMSDK.h

`– getCacheMediaFileName:mftype:fid:tid:fsuffix:`

获取随机缓存的媒体文件名称

- (NSString *)getCacheMediaFileName:(BOOL)fremote mftype:(int)mftype fid:(NSString *)fid tid:(NSString *)tid fsuffix:(NSString *)fsuffix

Parameters

`fremote`	是否是远程下载的文件
`mftype`	媒体类型(LVIM_MEDIA_FILE_TYPE)
`fid`	发送者ID
`tid`	接收者ID
`fsuffix`	文件后缀 *

Declared In

LVIMSDK.h

`– sendMessage:context:callback:`

发送消息

- (int)sendMessage:(LVIMMessage *)msg context:(id)context callback:(LVIM_SEND_MESSAGE_CALLBACK)callback

Parameters

`msg`	消息内容
`context`	传入接收代理对象(可空)
`callback`	结果回调(可空)

Return Value

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

Declared In

LVIMSDK.h

`– createChatroom:context:callback:`

创建房间

- (int)createChatroom:(NSString *)rid context:(id)context callback:(LVIM_SEND_MESSAGE_CALLBACK)callback

Parameters

`rid`	房间ID
`context`	传入接收代理对象(可空)
`callback`	结果回调(可空)

Return Value

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

Declared In

LVIMSDK.h

`– joinChatroom:context:callback:`

加入房间

- (int)joinChatroom:(NSString *)rid context:(id)context callback:(LVIM_SEND_MESSAGE_CALLBACK)callback

Parameters

`rid`	房间ID
`context`	传入接收代理对象(可空)
`callback`	结果回调(可空)

Return Value

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

Declared In

LVIMSDK.h

`– leaveChatroom:context:callback:`

离开房间

- (int)leaveChatroom:(NSString *)rid context:(id)context callback:(LVIM_SEND_MESSAGE_CALLBACK)callback

Parameters

`rid`	房间ID
`context`	传入接收代理对象(可空)
`callback`	结果回调(可空)

Return Value

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

Declared In

LVIMSDK.h

`– getCurrentRoomState`

获取当前房间的状态 *

- (LVIMRoomState *)getCurrentRoomState

Declared In

LVIMSDK.h

`– queryRemoteSessionList:pageSize:callback:`

拉取远程历史会话列表

- (int)queryRemoteSessionList:(int)pageIndex pageSize:(int)pageSize callback:(LVIM_QUERY_REMOTE_SESSION_LIST_CALLBACK)callback

Parameters

`pageIndex`	页面编号
`pageSize`	页面长度
`callback`	结果回调

Return Value

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

Declared In

LVIMSDK.h

`– queryRemoteSessionMessage:smsgid:sequence:size:callback:`

拉取远程某个会话的历史消息

- (int)queryRemoteSessionMessage:(NSString *)tuid smsgid:(int64_t)smsgid sequence:(int64_t)sequence size:(int)size callback:(LVIM_QUERY_REMOTE_SESSION_MESSAGE_CALLBACK)callback

Parameters

`tuid`	目标会话ID
`smsgid`	本地最后一条消息的服务端消息ID
`sequence`	本地最后一条数据的服务端消息序列
`size`	要获取的条数
`callback`	结果回调

Return Value

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

Declared In

LVIMSDK.h

`– deleteLocalPrivateHistoryMessage:`

删除本地私信历史消息记录

- (int)deleteLocalPrivateHistoryMessage:(NSString *)sessionid

Parameters

`sessionid`	某个人的UID

Return Value

成功返回删除条数, 失败返回<0的值 *

Declared In

LVIMSDK.h

`– deleteLocalGroupHistoryMessage:`

删除本地私信历史消息记录

- (int)deleteLocalGroupHistoryMessage:(NSString *)sessionid

Parameters

`sessionid`	某个群组的ID

Return Value

成功返回删除条数, 失败返回<0的值 *

Declared In

LVIMSDK.h

`– isHttpMessageEnabled`

是否启用了http消息

- (int)isHttpMessageEnabled

Return Value

未启用返回0, 独立连接启用返回1, 主连接启用返回2 *

Declared In

LVIMSDK.h

`– sendHttpMessage:method:content:headers:sendtmo:recvtmo:context:callback:`

发送http业务消息

- (int)sendHttpMessage:(NSString *)path method:(NSString *)method content:(NSString *)content headers:(NSString *)headers sendtmo:(int)sendtmo recvtmo:(int)recvtmo context:(id)context callback:(LVIM_SEND_HTTP_MESSAGE_CALLBACK)callback

Parameters

`path`	url请求地址后面的路径
`method`	请求方法(GET/POST/PUT…)
`content`	请求内容(可空)
`headers`	附加的请求头部(可空)
`sendtmo`	发送超时时间(1000毫秒 ~ 60000毫秒)
`recvtmo`	接收超时时间(1000毫秒 ~ 60000毫秒)
`context`	自定义上下文(可空)
`callback`	自定义回调(可空)

Return Value

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

Declared In

LVIMSDK.h

Other Methods

`– queryLocalPrivateHistoryMessage:dbid:limit:desc:rmsgs:`

查询本地私信消息历史记录

- (int)queryLocalPrivateHistoryMessage:(NSString *)sessionid dbid:(int64_t)dbid limit:(int32_t)limit desc:(BOOL)desc rmsgs:(NSMutableArray *)rmsgs

Parameters

`sessionid`	某个人的UID
`dbid`	参考数据id
`limit`	限制结果条数
`desc`	是否降序查询
`rmsgs`	结果集

Return Value

成功返回结果数量, 失败返回<0的值 *

Declared In

LVIMSDK.h

`– queryLocalGroupHistoryMessage:dbid:limit:desc:rmsgs:`

查询本地群组消息历史记录

- (int)queryLocalGroupHistoryMessage:(NSString *)sessionid dbid:(int64_t)dbid limit:(int32_t)limit desc:(BOOL)desc rmsgs:(NSMutableArray *)rmsgs

Parameters

`sessionid`	某个群组的ID
`dbid`	参考数据id
`limit`	限制结果条数
`desc`	是否降序查询
`rmsgs`	结果集

Return Value

成功返回结果数量, 失败返回<0的值 *

Declared In

LVIMSDK.h