RCIMClient Class Reference

Inherits from	NSObject
Declared in	RCIMClient.h

`+ sharedRCIMClient`

获取融云通讯能力库 IMLib 的核心类单例

+ (instancetype)sharedRCIMClient

Return Value

融云通讯能力库 IMLib 的核心单例类

Discussion

获取融云通讯能力库 IMLib 的核心类单例

您可以通过此方法，获取 IMLib 的单例，访问对象中的属性和方法.

Declared In

RCIMClient.h

`– initWithAppKey:`

初始化融云 SDK

- (void)initWithAppKey:(NSString *)appKey

Parameters

`appKey`	从融云开发者平台创建应用后获取到的 App Key

Discussion

初始化融云 SDK

初始化后，SDK 会监听 app 生命周期，用于判断应用处于前台、后台，根据前后台状态调整链接心跳 @discussion 您在使用融云 SDK 所有功能（包括显示 SDK 中或者继承于 SDK 的 View ）之前，您必须先调用此方法初始化 SDK。在 App 整个生命周期中，您只需要执行一次初始化。

升级说明: 从2.4.1版本开始，为了兼容 Swift 的风格与便于使用，将原有的 init: 方法升级为此方法，方法的功能和使用均不变。

Warning: 如果您使用 IMLib，请使用此方法初始化 SDK；如果您使用 IMKit，请使用 RCIM 中的同名方法初始化，而不要使用此方法。

@remarks 连接

Declared In

RCIMClient.h

`– setDeviceTokenData:`

设置 deviceToken（已兼容 iOS 13），用于远程推送

- (void)setDeviceTokenData:(NSData *)deviceTokenData

Parameters

`deviceTokenData`	从系统获取到的设备号 deviceTokenData (不需要处理) @discussion deviceToken 是系统提供的，从苹果服务器获取的，用于 APNs 远程推送必须使用的设备唯一值。您需要将 -application:didRegisterForRemoteNotificationsWithDeviceToken: 获取到的 deviceToken 作为参数传入此方法。如: (void)application:(UIApplication )application didRegisterForRemoteNotificationsWithDeviceToken:(NSData )deviceToken { [[RCIMClient sharedRCIMClient] setDeviceTokenData:deviceToken]; } @remarks 功能设置

deviceTokenData

从系统获取到的设备号 deviceTokenData (不需要处理)

@discussion deviceToken 是系统提供的，从苹果服务器获取的，用于 APNs 远程推送必须使用的设备唯一值。您需要将 -application:didRegisterForRemoteNotificationsWithDeviceToken: 获取到的 deviceToken 作为参数传入此方法。

如:

(void)application:(UIApplication )application didRegisterForRemoteNotificationsWithDeviceToken:(NSData )deviceToken { [[RCIMClient sharedRCIMClient] setDeviceTokenData:deviceToken]; } @remarks 功能设置

Discussion

设置 deviceToken（已兼容 iOS 13），用于远程推送

Declared In

RCIMClient.h

`– setDeviceToken:`

设置 deviceToken，用于远程推送

- (void)setDeviceToken:(NSString *)deviceToken

Parameters

`deviceToken`	从系统获取到的设备号 deviceToken @discussion deviceToken 是系统提供的，从苹果服务器获取的，用于 APNs 远程推送必须使用的设备唯一值。您需要将 -application:didRegisterForRemoteNotificationsWithDeviceToken: 获取到的 deviceToken，转换成十六进制字符串，作为参数传入此方法。如: - (void)application:(UIApplication )application didRegisterForRemoteNotificationsWithDeviceToken:(NSData )deviceToken { NSString token = [self getHexStringForData:deviceToken]; [[RCIMClient sharedRCIMClient] setDeviceToken:token]; } - (NSString )getHexStringForData:(NSData )data { NSUInteger len = [data length]; char chars = (char )[data bytes]; NSMutableString hexString = [[NSMutableString alloc] init]; for (NSUInteger i = 0; i < len; i ++) { [hexString appendString:[NSString stringWithFormat:@"%0.2hhx", chars[i]]]; } return hexString; } @remarks 功能设置

deviceToken

从系统获取到的设备号 deviceToken

@discussion deviceToken 是系统提供的，从苹果服务器获取的，用于 APNs 远程推送必须使用的设备唯一值。您需要将 -application:didRegisterForRemoteNotificationsWithDeviceToken: 获取到的 deviceToken，转换成十六进制字符串，作为参数传入此方法。

如:

- (void)application:(UIApplication *)application
didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    NSString *token = [self getHexStringForData:deviceToken];
    [[RCIMClient sharedRCIMClient] setDeviceToken:token];
}

- (NSString *)getHexStringForData:(NSData *)data {
    NSUInteger len = [data length];
    char *chars = (char *)[data bytes];
    NSMutableString *hexString = [[NSMutableString alloc] init];
    for (NSUInteger i = 0; i < len; i ++) {
        [hexString appendString:[NSString stringWithFormat:@"%0.2hhx", chars[i]]];
    }
    return hexString;
 }

@remarks 功能设置

Discussion

设置 deviceToken，用于远程推送

Declared In

RCIMClient.h

`naviServer`	导航服务器地址，具体的格式参考下面的说明
`fileServer`	文件服务器地址，具体的格式参考下面的说明

Warning: 仅限独立数据中心使用，使用前必须先联系商务开通。必须在 SDK init 之前进行设置。 @discussion naviServer 必须为有效的服务器地址，fileServer 如果想使用默认的，可以传 nil。 naviServer 和 fileServer 的格式说明： 1、如果使用 https，则设置为 https://cn.xxx.com:port 或 https://cn.xxx.com 格式，其中域名部分也可以是 IP，如果不指定端口，将默认使用 443 端口。 2、如果使用 http，则设置为 cn.xxx.com:port 或 cn.xxx.com 格式，其中域名部分也可以是 IP，如果不指定端口，将默认使用 80 端口。（iOS 默认只能使⽤ HTTPS 协议。如果您使⽤ http 协议，请参考 iOS 开发⽂档中的 ATS 设置说明。链接如下：https://support.rongcloud.cn/ks/OTQ1 ）

@remarks 功能设置

Declared In

RCIMClient.h

`– setStatisticServer:`

设置统计服务器的信息

- (BOOL)setStatisticServer:(NSString *)statisticServer

Parameters

`statisticServer`	统计服务器地址，具体的格式参考下面的说明

Return Value

是否设置成功

Discussion

设置统计服务器的信息

Warning: 仅限独立数据中心使用，使用前必须先联系商务开通。必须在 SDK init 和 setDeviceToken 之前进行设置。 @discussion statisticServer 必须为有效的服务器地址，否则会造成推送等业务不能正常使用。格式说明： 1、如果使用 https，则设置为 https://cn.xxx.com:port 或 https://cn.xxx.com 格式，其中域名部分也可以是 IP，如果不指定端口，将默认使用 443 端口。 2、如果使用 http，则设置为 cn.xxx.com:port 或 cn.xxx.com 格式，其中域名部分也可以是 IP，如果不指定端口，将默认使用 80 端口。（iOS 默认只能使⽤ HTTPS 协议。如果您使⽤ http 协议，请参考 iOS 开发⽂档中的 ATS 设置说明。链接如下：https://support.rongcloud.cn/ks/OTQ1 ）

@remarks 功能设置

Declared In

RCIMClient.h

`– connectWithToken:dbOpened:success:error:`

与融云服务器建立连接

- (void)connectWithToken:(NSString *)token dbOpened:(void ( ^ ) ( RCDBErrorCode code ))dbOpenedBlock success:(void ( ^ ) ( NSString *userId ))successBlock error:(void ( ^ ) ( RCConnectErrorCode errorCode ))errorBlock

Parameters

`token`	从您服务器端获取的 token (用户身份令牌)
`dbOpenedBlock`	本地消息数据库打开的回调
`successBlock`	连接建立成功的回调 [ userId: 当前连接成功所用的用户 ID]
`errorBlock`	连接建立失败的回调，触发该回调代表 SDK 无法继续重连 [errorCode: 连接失败的错误码]

Discussion

与融云服务器建立连接

调用该接口，SDK 会在连接失败之后尝试重连，直到连接成功或者出现 SDK 无法处理的错误（如 token 非法）。如果您不想一直进行重连，可以使用 connectWithToken:timeLimit:dbOpened:success:error: 接口并设置连接超时时间 timeLimit。

连接成功后，SDK 将接管所有的重连处理。当因为网络原因断线的情况下，SDK 会不停重连直到连接成功为止，不需要您做额外的连接操作。

对于 errorBlock 需要特定关心 tokenIncorrect 的情况：一是 token 错误，请您检查客户端初始化使用的 AppKey 和您服务器获取 token 使用的 AppKey 是否一致；二是 token 过期，是因为您在开发者后台设置了 token 过期时间，您需要请求您的服务器重新获取 token 并再次用新的 token 建立连接。在此种情况下，您需要请求您的服务器重新获取 token 并建立连接，但是注意避免无限循环，以免影响 App 用户体验。

Warning: 如果您使用 IMLib，请使用此方法建立与融云服务器的连接；如果您使用 IMKit，请使用 RCIM 中的同名方法建立与融云服务器的连接，而不要使用此方法。

此方法的回调并非为原调用线程，您如果需要进行 UI 操作，请注意切换到主线程。

Declared In

RCIMClient.h

`– connectWithToken:timeLimit:dbOpened:success:error:`

与融云服务器建立连接

- (void)connectWithToken:(NSString *)token timeLimit:(int)timeLimit dbOpened:(void ( ^ ) ( RCDBErrorCode code ))dbOpenedBlock success:(void ( ^ ) ( NSString *userId ))successBlock error:(void ( ^ ) ( RCConnectErrorCode errorCode ))errorBlock

Parameters

`token`	从您服务器端获取的 token (用户身份令牌)
`timeLimit`	SDK 连接的超时时间，单位: 秒 timeLimit <= 0，SDK 会一直连接，直到连接成功或者出现 SDK 无法处理的错误（如 token 非法）。 timeLimit > 0，SDK 最多连接 timeLimit 秒，超时时返回 RC_CONNECT_TIMEOUT 错误，并不再重连。
`dbOpenedBlock`	本地消息数据库打开的回调
`successBlock`	连接建立成功的回调 [ userId: 当前连接成功所用的用户 ID]
`errorBlock`	连接建立失败的回调，触发该回调代表 SDK 无法继续重连 [errorCode: 连接失败的错误码]

Discussion

与融云服务器建立连接

调用该接口，SDK 会在 timeLimit 秒内尝试重连，直到出现下面三种情况之一：第一、连接成功，回调 successBlock(userId)。第二、超时，回调 errorBlock(RC_CONNECT_TIMEOUT)。第三、出现 SDK 无法处理的错误，回调 errorBlock(errorCode)（如 token 非法）。

连接成功后，SDK 将接管所有的重连处理。当因为网络原因断线的情况下，SDK 会不停重连直到连接成功为止，不需要您做额外的连接操作。

对于 errorBlock 需要特定关心 tokenIncorrect 的情况：一是 token 错误，请您检查客户端初始化使用的 AppKey 和您服务器获取 token 使用的 AppKey 是否一致；二是 token 过期，是因为您在开发者后台设置了 token 过期时间，您需要请求您的服务器重新获取 token 并再次用新的 token 建立连接。在此种情况下，您需要请求您的服务器重新获取 token 并建立连接，但是注意避免无限循环，以免影响 App 用户体验。

Warning: 如果您使用 IMLib，请使用此方法建立与融云服务器的连接；如果您使用 IMKit，请使用 RCIM 中的同名方法建立与融云服务器的连接，而不要使用此方法。

此方法的回调并非为原调用线程，您如果需要进行 UI 操作，请注意切换到主线程。

Declared In

RCIMClient.h

`– disconnect:`

断开与融云服务器的连接

- (void)disconnect:(BOOL)isReceivePush

Parameters

`isReceivePush`	App 在断开连接之后，是否还接收远程推送 @discussion 因为 SDK 在前后台切换或者网络出现异常都会自动重连，会保证连接的可靠性。所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开。

isReceivePush

App 在断开连接之后，是否还接收远程推送

@discussion 因为 SDK 在前后台切换或者网络出现异常都会自动重连，会保证连接的可靠性。所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开。

Discussion

断开与融云服务器的连接

Warning: 如果您使用 IMLib，请使用此方法断开与融云服务器的连接；如果您使用 IMKit，请使用 RCIM 中的同名方法断开与融云服务器的连接，而不要使用此方法。

isReceivePush 指断开与融云服务器的连接之后，是否还接收远程推送。 [[RCIMClient sharedRCIMClient] disconnect:YES] 与 [[RCIMClient sharedRCIMClient] disconnect] 完全一致； [[RCIMClient sharedRCIMClient] disconnect:NO] 与[ [RCIMClient sharedRCIMClient] logout] 完全一致。您只需要按照您的需求，使用 disconnect: 与 disconnect 以及 logout 三个接口其中一个即可。

@remarks 连接

Declared In

RCIMClient.h

`– disconnect`

断开与融云服务器的连接，但仍然接收远程推送

- (void)disconnect

Discussion

断开与融云服务器的连接，但仍然接收远程推送

@discussion 因为 SDK 在前后台切换或者网络出现异常都会自动重连，会保证连接的可靠性。所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开。

Warning: 如果您使用 IMLib，请使用此方法断开与融云服务器的连接；如果您使用 IMKit，请使用 RCIM 中的同名方法断开与融云服务器的连接，而不要使用此方法。

[[RCIMClient sharedRCIMClient] disconnect:YES] 与 [[RCIMClient sharedRCIMClient] disconnect] 完全一致； [[RCIMClient sharedRCIMClient] disconnect:NO] 与 [[RCIMClient sharedRCIMClient] logout] 完全一致。您只需要按照您的需求，使用 disconnect: 与 disconnect 以及 logout 三个接口其中一个即可。

@remarks 连接

Declared In

RCIMClient.h

`– logout`

断开与融云服务器的连接，并不再接收远程推送

- (void)logout

Discussion

断开与融云服务器的连接，并不再接收远程推送

@discussion 因为 SDK 在前后台切换或者网络出现异常都会自动重连，会保证连接的可靠性。所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开。

Warning: 如果您使用 IMKit，请使用此方法断开与融云服务器的连接；如果您使用 IMLib，请使用 RCIMClient 中的同名方法断开与融云服务器的连接，而不要使用此方法。

[[RCIMClient sharedRCIMClient] disconnect:YES] 与 [[RCIMClient sharedRCIMClient] disconnect] 完全一致； [[RCIMClient sharedRCIMClient] disconnect:NO] 与 [[RCIMClient sharedRCIMClient] logout] 完全一致。您只需要按照您的需求，使用 disconnect: 与 disconnect 以及 logout 三个接口其中一个即可。

@remarks 连接

Declared In

RCIMClient.h

`– setReconnectKickEnable:`

设置断线重连时是否踢出当前正在重连的设备

- (void)setReconnectKickEnable:(BOOL)enable

Parameters

`enable`	是否踢出重连设备 @remarks 功能设置

enable

是否踢出重连设备

@remarks 功能设置

Discussion

设置断线重连时是否踢出当前正在重连的设备

@discussion 用户没有开通多设备登录功能的前提下，同一个账号在一台新设备上登录的时候，会把这个账号在之前登录的设备上踢出。由于 SDK 有断线重连功能，存在下面情况。用户在 A 设备登录，A 设备网络不稳定，没有连接成功，SDK 启动重连机制。用户此时又在 B 设备登录，B 设备连接成功。 A 设备网络稳定之后，用户在 A 设备连接成功，B 设备被踢出。这个接口就是为这种情况加的。设置 enable 为 YES 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。

Declared In

RCIMClient.h

`– setRCConnectionStatusChangeDelegate:`

设置 IMLib 的连接状态监听器

- (void)setRCConnectionStatusChangeDelegate:(id<RCConnectionStatusChangeDelegate>)delegate

Parameters

`delegate`	IMLib 连接状态监听器

Discussion

设置 IMLib 的连接状态监听器

Warning: 如果您使用 IMLib，可以设置并实现此 Delegate 监听连接状态变化；如果您使用 IMKit，请使用 RCIM 中的 connectionStatusDelegate 监听连接状态变化，而不要使用此方法，否则会导致 IMKit 中无法自动更新 UI！

@remarks 功能设置

Declared In

RCIMClient.h

`– getConnectionStatus`

获取当前 SDK 的连接状态

- (RCConnectionStatus)getConnectionStatus

Return Value

当前 SDK 的连接状态

@remarks 数据获取

Discussion

获取当前 SDK 的连接状态

Declared In

RCIMClient.h

`– getCurrentNetworkStatus`

获取当前的网络状态

- (RCNetworkStatus)getCurrentNetworkStatus

Return Value

当前的网路状态

@remarks 数据获取

Discussion

获取当前的网络状态

Declared In

RCIMClient.h

`sdkRunningMode`

SDK 当前所处的运行状态

@property (nonatomic, assign, readonly) RCSDKRunningMode sdkRunningMode

Discussion

SDK 当前所处的运行状态

@remarks 数据获取

Declared In

RCIMClient.h

`watchKitStatusDelegate`

用于 Apple Watch 的 IMLib 事务监听器

@property (nonatomic, strong) id<RCWatchKitStatusDelegate> watchKitStatusDelegate

Discussion

用于 Apple Watch 的 IMLib 事务监听器

@remarks 功能设置

Declared In

RCIMClient.h

`– setRCMessageDestructDelegate:`

设置 IMLib 的阅后即焚监听器

- (void)setRCMessageDestructDelegate:(id<RCMessageDestructDelegate>)delegate

Parameters

`delegate`	阅后即焚监听器

Discussion

设置 IMLib 的阅后即焚监听器

可以设置并实现此 Delegate 监听消息焚烧

Warning: 如果您使用 IMKit，请不要使用此监听器，否则会导致 IMKit 中无法自动更新 UI！

@remarks 功能设置

Declared In

RCIMClient.h

`currentUserInfo`

当前登录用户的用户信息

@property (nonatomic, strong) RCUserInfo *currentUserInfo

Discussion

当前登录用户的用户信息

用于与融云服务器建立连接之后，设置当前用户的用户信息。

Warning: 如果传入的用户信息中的用户 ID 与当前登录的用户 ID 不匹配，则将会忽略。如果您使用 IMLib，请使用此字段设置当前登录用户的用户信息；如果您使用 IMKit，请使用 RCIM 中的 currentUserInfo 设置当前登录用户的用户信息，而不要使用此字段。

@remarks 数据获取

Declared In

RCIMClient.h

`– registerMessageType:`

注册自定义的消息类型

- (void)registerMessageType:(Class)messageClass

Parameters

`messageClass`	自定义消息的类，该自定义消息需要继承于 RCMessageContent @discussion 如果您需要自定义消息，必须调用此方法注册该自定义消息的消息类型，否则 SDK 将无法识别和解析该类型消息。

messageClass

自定义消息的类，该自定义消息需要继承于 RCMessageContent

@discussion 如果您需要自定义消息，必须调用此方法注册该自定义消息的消息类型，否则 SDK 将无法识别和解析该类型消息。

Discussion

注册自定义的消息类型

请在初始化 appkey 之后，token 连接之前调用该方法注册自定义消息

Warning: 如果您使用 IMLib，请使用此方法注册自定义的消息类型；如果您使用 IMKit，请使用 RCIM 中的同名方法注册自定义的消息类型，而不要使用此方法。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMessage:targetId:content:pushContent:pushData:success:error:`

发送消息

- (RCMessage *)sendMessage:(RCConversationType)conversationType targetId:(NSString *)targetId content:(RCMessageContent *)content pushContent:(NSString *)pushContent pushData:(NSString *)pushData success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode , long messageId ))errorBlock

Parameters

`conversationType`	发送消息的会话类型
`targetId`	发送消息的会话 ID
`content`	消息的内容
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`successBlock`	消息发送成功的回调 [messageId: 消息的 ID]
`errorBlock`	消息发送失败的回调 [nErrorCode: 发送失败的错误码, messageId:消息的ID]

Return Value

发送的消息实体

Discussion

发送消息

当接收方离线并允许远程推送时，会收到远程推送。远程推送中包含两部分内容，一是 pushContent ，用于显示；二是 pushData ，用于携带不显示的数据。

SDK 内置的消息类型，如果您将 pushContent 和 pushData 置为 nil ，会使用默认的推送格式进行远程推送。自定义类型的消息，需要您自己设置 pushContent 和 pushData 来定义推送内容，否则将不会进行远程推送。

如果您使用此方法发送图片消息，需要您自己实现图片的上传，构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

如果您使用此方法发送文件消息，需要您自己实现文件的上传，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

Warning: 如果您使用 IMLib，可以使用此方法发送消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送消息，否则不会自动更新 UI。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMessage:targetId:content:pushContent:pushData:option:success:error:`

发送消息

- (RCMessage *)sendMessage:(RCConversationType)conversationType targetId:(NSString *)targetId content:(RCMessageContent *)content pushContent:(NSString *)pushContent pushData:(NSString *)pushData option:(RCSendMessageOption *)option success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode , long messageId ))errorBlock

Parameters

`conversationType`	发送消息的会话类型
`targetId`	发送消息的会话 ID
`content`	消息的内容
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`option`	消息的相关配置
`successBlock`	消息发送成功的回调 [messageId: 消息的 ID]
`errorBlock`	消息发送失败的回调 [nErrorCode: 发送失败的错误码, messageId: 消息的 ID]

Return Value

发送的消息实体

Discussion

发送消息

当接收方离线并允许远程推送时，会收到远程推送。远程推送中包含两部分内容，一是 pushContent，用于显示；二是 pushData，用于携带不显示的数据。

SDK 内置的消息类型，如果您将 pushContent 和 pushData 置为 nil，会使用默认的推送格式进行远程推送。自定义类型的消息，需要您自己设置 pushContent 和 pushData 来定义推送内容，否则将不会进行远程推送。

如果您使用此方法发送图片消息，需要您自己实现图片的上传，构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

如果您使用此方法发送文件消息，需要您自己实现文件的上传，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

Warning: 如果您使用 IMLib，可以使用此方法发送消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送消息，否则不会自动更新 UI。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMediaMessage:targetId:content:pushContent:pushData:progress:success:error:cancel:`

发送媒体消息（图片消息或文件消息）

- (RCMessage *)sendMediaMessage:(RCConversationType)conversationType targetId:(NSString *)targetId content:(RCMessageContent *)content pushContent:(NSString *)pushContent pushData:(NSString *)pushData progress:(void ( ^ ) ( int progress , long messageId ))progressBlock success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode errorCode , long messageId ))errorBlock cancel:(void ( ^ ) ( long messageId ))cancelBlock

Parameters

`conversationType`	发送消息的会话类型
`targetId`	发送消息的会话 ID
`content`	消息的内容
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`progressBlock`	消息发送进度更新的回调 [progress:当前的发送进度, 0 <= progress <= 100, messageId:消息的 ID]
`successBlock`	消息发送成功的回调 [messageId:消息的 ID]
`errorBlock`	消息发送失败的回调 [errorCode:发送失败的错误码, messageId:消息的 ID]
`cancelBlock`	用户取消了消息发送的回调 [messageId:消息的 ID]

Return Value

发送的消息实体

Discussion

发送媒体消息（图片消息或文件消息）

当接收方离线并允许远程推送时，会收到远程推送。远程推送中包含两部分内容，一是 pushContent，用于显示；二是 pushData，用于携带不显示的数据。

SDK 内置的消息类型，如果您将 pushContent 和 pushData 置为 nil，会使用默认的推送格式进行远程推送。自定义类型的消息，需要您自己设置 pushContent 和 pushData 来定义推送内容，否则将不会进行远程推送。

如果您需要上传图片到自己的服务器，需要构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

如果您需要上传文件到自己的服务器，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

Warning: 如果您使用 IMLib，可以使用此方法发送媒体消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送媒体消息，否则不会自动更新 UI。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMediaMessage:targetId:content:pushContent:pushData:uploadPrepare:progress:success:error:cancel:`

发送媒体消息(上传图片或文件等媒体信息到指定的服务器)

- (RCMessage *)sendMediaMessage:(RCConversationType)conversationType targetId:(NSString *)targetId content:(RCMessageContent *)content pushContent:(NSString *)pushContent pushData:(NSString *)pushData uploadPrepare:(void ( ^ ) ( RCUploadMediaStatusListener *uploadListener ))uploadPrepareBlock progress:(void ( ^ ) ( int progress , long messageId ))progressBlock success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode errorCode , long messageId ))errorBlock cancel:(void ( ^ ) ( long messageId ))cancelBlock

Parameters

`conversationType`	发送消息的会话类型
`targetId`	发送消息的会话 ID
`content`	消息的内容
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`uploadPrepareBlock`	媒体文件上传进度更新的 IMKit 监听 [uploadListener:当前的发送进度监听，SDK 通过此监听更新 IMKit UI]
`progressBlock`	消息发送进度更新的回调 [progress:当前的发送进度, 0 <= progress <= 100, messageId:消息的ID]
`successBlock`	消息发送成功的回调 [messageId:消息的 ID]
`errorBlock`	消息发送失败的回调 [errorCode:发送失败的错误码, messageId:消息的 ID]
`cancelBlock`	用户取消了消息发送的回调 [messageId:消息的 ID]

Return Value

发送的消息实体

Discussion

发送媒体消息(上传图片或文件等媒体信息到指定的服务器)

此方法仅用于 IMKit。如果您需要上传图片到自己的服务器并使用 IMLib，构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

如果您需要上传文件到自己的服务器并使用 IMLib，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMessage:pushContent:pushData:successBlock:errorBlock:`

发送消息

- (RCMessage *)sendMessage:(RCMessage *)message pushContent:(NSString *)pushContent pushData:(NSString *)pushData successBlock:(void ( ^ ) ( RCMessage *successMessage ))successBlock errorBlock:(void ( ^ ) ( RCErrorCode nErrorCode , RCMessage *errorMessage ))errorBlock

Parameters

`message`	将要发送的消息实体（需要保证 message 中的 conversationType，targetId，messageContent 是有效值)
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`successBlock`	消息发送成功的回调 [successMessage: 消息实体]
`errorBlock`	消息发送失败的回调 [nErrorCode: 发送失败的错误码, errorMessage:消息实体]

Return Value

发送的消息实体

Discussion

发送消息

当接收方离线并允许远程推送时，会收到远程推送。远程推送中包含两部分内容，一是 pushContent ，用于显示；二是 pushData ，用于携带不显示的数据。

SDK 内置的消息类型，如果您将 pushContent 和 pushData 置为 nil ，会使用默认的推送格式进行远程推送。自定义类型的消息，需要您自己设置 pushContent 和 pushData 来定义推送内容，否则将不会进行远程推送。

如果您使用此方法发送图片消息，需要您自己实现图片的上传，构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

如果您使用此方法发送文件消息，需要您自己实现文件的上传，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用此方法发送。

Warning: 如果您使用 IMLib，可以使用此方法发送消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送消息，否则不会自动更新 UI。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendMediaMessage:pushContent:pushData:progress:successBlock:errorBlock:cancel:`

发送媒体消息（图片消息或文件消息）

- (RCMessage *)sendMediaMessage:(RCMessage *)message pushContent:(NSString *)pushContent pushData:(NSString *)pushData progress:(void ( ^ ) ( int progress , RCMessage *progressMessage ))progressBlock successBlock:(void ( ^ ) ( RCMessage *successMessage ))successBlock errorBlock:(void ( ^ ) ( RCErrorCode nErrorCode , RCMessage *errorMessage ))errorBlock cancel:(void ( ^ ) ( RCMessage *cancelMessage ))cancelBlock

Parameters

`message`	将要发送的消息实体（需要保证 message 中的 conversationType，targetId，messageContent 是有效值)
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`progressBlock`	消息发送进度更新的回调 [progress:当前的发送进度, 0 <= progress <= 100, progressMessage:消息实体]
`successBlock`	消息发送成功的回调 [successMessage:消息实体]
`errorBlock`	消息发送失败的回调 [nErrorCode:发送失败的错误码, errorMessage:消息实体]
`cancelBlock`	用户取消了消息发送的回调 [cancelMessage:消息实体]

Return Value

发送的消息实体

Discussion

发送媒体消息（图片消息或文件消息）

当接收方离线并允许远程推送时，会收到远程推送。远程推送中包含两部分内容，一是 pushContent，用于显示；二是 pushData，用于携带不显示的数据。

SDK 内置的消息类型，如果您将 pushContent 和 pushData 置为 nil，会使用默认的推送格式进行远程推送。自定义类型的消息，需要您自己设置 pushContent 和 pushData 来定义推送内容，否则将不会进行远程推送。

如果您需要上传图片到自己的服务器，需要构建一个 RCImageMessage 对象，并将 RCImageMessage 中的 imageUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

如果您需要上传文件到自己的服务器，构建一个 RCFileMessage 对象，并将 RCFileMessage 中的 fileUrl 字段设置为上传成功的 URL 地址，然后使用 RCIMClient 的 sendMessage:targetId:content:pushContent:pushData:success:error:方法或 sendMessage:targetId:content:pushContent:success:error:方法进行发送，不要使用此方法。

Warning: 如果您使用 IMLib，可以使用此方法发送媒体消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送媒体消息，否则不会自动更新 UI。

@remarks 消息操作

Declared In

RCIMClient.h

`– cancelSendMediaMessage:`

取消发送中的媒体信息

- (BOOL)cancelSendMediaMessage:(long)messageId

Parameters

`messageId`	媒体消息的 messageId

Return Value

YES 表示取消成功，NO 表示取消失败，即已经发送成功或者消息不存在。

@remarks 消息操作

Discussion

取消发送中的媒体信息

Declared In

RCIMClient.h

`– batchInsertMessage:`

批量插入接收的消息（该消息只插入本地数据库，实际不会发送给服务器和对方） RCMessage 下列属性会被入库，其余属性会被抛弃 conversationType 会话类型 targetId 会话 ID messageDirection 消息方向 senderUserId 发送者 ID receivedStatus 接收状态；消息方向为接收方，并且 receivedStatus 为 ReceivedStatus_UNREAD 时，该条消息未读 sentStatus 发送状态 content 消息的内容 sentTime 消息发送的 Unix 时间戳，单位为毫秒，会影响消息排序 extra RCMessage 的额外字段

- (BOOL)batchInsertMessage:(NSArray<RCMessage*> *)msgs

Discussion

批量插入接收的消息（该消息只插入本地数据库，实际不会发送给服务器和对方） RCMessage 下列属性会被入库，其余属性会被抛弃 conversationType 会话类型 targetId 会话 ID messageDirection 消息方向 senderUserId 发送者 ID receivedStatus 接收状态；消息方向为接收方，并且 receivedStatus 为 ReceivedStatus_UNREAD 时，该条消息未读 sentStatus 发送状态 content 消息的内容 sentTime 消息发送的 Unix 时间戳，单位为毫秒，会影响消息排序 extra RCMessage 的额外字段

此方法不支持聊天室的会话类型。每批最多处理 500 条消息，超过 500 条返回 NO

消息的未读会累加到回话的未读数上

@remarks 消息操作

Declared In

RCIMClient.h

`– insertOutgoingMessage:targetId:sentStatus:content:`

插入向外发送的消息（该消息只插入本地数据库，实际不会发送给服务器和对方）

- (RCMessage *)insertOutgoingMessage:(RCConversationType)conversationType targetId:(NSString *)targetId sentStatus:(RCSentStatus)sentStatus content:(RCMessageContent *)content

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`sentStatus`	发送状态
`content`	消息的内容

Return Value

插入的消息实体

Discussion

插入向外发送的消息（该消息只插入本地数据库，实际不会发送给服务器和对方）

此方法不支持聊天室的会话类型。

@remarks 消息操作

Declared In

RCIMClient.h

`– insertOutgoingMessage:targetId:sentStatus:content:sentTime:`

插入向外发送的、指定时间的消息（此方法如果 sentTime 有问题会影响消息排序，慎用！！）（该消息只插入本地数据库，实际不会发送给服务器和对方）

- (RCMessage *)insertOutgoingMessage:(RCConversationType)conversationType targetId:(NSString *)targetId sentStatus:(RCSentStatus)sentStatus content:(RCMessageContent *)content sentTime:(long long)sentTime

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`sentStatus`	发送状态
`content`	消息的内容
`sentTime`	消息发送的 Unix 时间戳，单位为毫秒（传 0 会按照本地时间插入）

Return Value

插入的消息实体

Discussion

插入向外发送的、指定时间的消息（此方法如果 sentTime 有问题会影响消息排序，慎用！！）（该消息只插入本地数据库，实际不会发送给服务器和对方）

此方法不支持聊天室的会话类型。如果 sentTime<=0，则被忽略，会以插入时的时间为准。

@remarks 消息操作

Declared In

RCIMClient.h

`– insertIncomingMessage:targetId:senderUserId:receivedStatus:content:`

插入接收的消息（该消息只插入本地数据库，实际不会发送给服务器和对方）

- (RCMessage *)insertIncomingMessage:(RCConversationType)conversationType targetId:(NSString *)targetId senderUserId:(NSString *)senderUserId receivedStatus:(RCReceivedStatus)receivedStatus content:(RCMessageContent *)content

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`senderUserId`	发送者 ID
`receivedStatus`	接收状态
`content`	消息的内容

Return Value

插入的消息实体

Discussion

插入接收的消息（该消息只插入本地数据库，实际不会发送给服务器和对方）

此方法不支持聊天室的会话类型。

@remarks 消息操作

Declared In

RCIMClient.h

`– insertIncomingMessage:targetId:senderUserId:receivedStatus:content:sentTime:`

插入接收的消息（此方法如果 sentTime 有问题会影响消息排序，慎用！！）（该消息只插入本地数据库，实际不会发送给服务器和对方）

- (RCMessage *)insertIncomingMessage:(RCConversationType)conversationType targetId:(NSString *)targetId senderUserId:(NSString *)senderUserId receivedStatus:(RCReceivedStatus)receivedStatus content:(RCMessageContent *)content sentTime:(long long)sentTime

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`senderUserId`	发送者 ID
`receivedStatus`	接收状态
`content`	消息的内容
`sentTime`	消息发送的 Unix 时间戳，单位为毫秒（传 0 会按照本地时间插入）

Return Value

插入的消息实体

Discussion

插入接收的消息（此方法如果 sentTime 有问题会影响消息排序，慎用！！）（该消息只插入本地数据库，实际不会发送给服务器和对方）

此方法不支持聊天室的会话类型。

@remarks 消息操作

Declared In

RCIMClient.h

`– downloadMediaFile:mediaUrl:progress:success:error:cancel:`

根据文件 URL 地址下载文件内容

- (void)downloadMediaFile:(NSString *)fileName mediaUrl:(NSString *)mediaUrl progress:(void ( ^ ) ( int progress ))progressBlock success:(void ( ^ ) ( NSString *mediaPath ))successBlock error:(void ( ^ ) ( RCErrorCode errorCode ))errorBlock cancel:(void ( ^ ) ( void ))cancelBlock

Parameters

`fileName`	指定的文件名称需要开发者指定文件后缀 (例如 rongCloud.mov)
`mediaUrl`	文件的 URL 地址
`progressBlock`	文件下载进度更新的回调 [progress:当前的下载进度, 0 <= progress <= 100]
`successBlock`	下载成功的回调[mediaPath:下载成功后本地存放的文件路径文件路径为文件消息的默认地址]
`errorBlock`	下载失败的回调[errorCode:下载失败的错误码]
`cancelBlock`	用户取消了下载的回调

Discussion

根据文件 URL 地址下载文件内容

用来获取媒体原文件时调用。如果本地缓存中包含此文件，则从本地缓存中直接获取，否则将从服务器端下载。

@remarks 多媒体下载

Declared In

RCIMClient.h

`– downloadMediaFile:targetId:mediaType:mediaUrl:progress:success:error:cancel:`

下载消息内容中的媒体信息

- (void)downloadMediaFile:(RCConversationType)conversationType targetId:(NSString *)targetId mediaType:(RCMediaType)mediaType mediaUrl:(NSString *)mediaUrl progress:(void ( ^ ) ( int progress ))progressBlock success:(void ( ^ ) ( NSString *mediaPath ))successBlock error:(void ( ^ ) ( RCErrorCode errorCode ))errorBlock cancel:(void ( ^ ) ( void ))cancelBlock

Parameters

`conversationType`	消息的会话类型
`targetId`	消息的会话 ID
`mediaType`	消息内容中的多媒体文件类型，目前仅支持图片
`mediaUrl`	多媒体文件的网络 URL
`progressBlock`	消息下载进度更新的回调 [progress:当前的下载进度, 0 <= progress <= 100]
`successBlock`	下载成功的回调 [mediaPath:下载成功后本地存放的文件路径]
`errorBlock`	下载失败的回调[errorCode:下载失败的错误码]
`cancelBlock`	用户取消了下载的回调

Discussion

下载消息内容中的媒体信息

用来获取媒体原文件时调用。如果本地缓存中包含此文件，则从本地缓存中直接获取，否则将从服务器端下载。 @remarks 多媒体下载

Declared In

RCIMClient.h

`– downloadMediaMessage:progress:success:error:cancel:`

下载消息内容中的媒体信息

- (void)downloadMediaMessage:(long)messageId progress:(void ( ^ ) ( int progress ))progressBlock success:(void ( ^ ) ( NSString *mediaPath ))successBlock error:(void ( ^ ) ( RCErrorCode errorCode ))errorBlock cancel:(void ( ^ ) ( void ))cancelBlock

Parameters

`messageId`	媒体消息的 messageId
`progressBlock`	消息下载进度更新的回调 [progress:当前的下载进度, 0 <= progress <= 100]
`successBlock`	下载成功的回调[mediaPath:下载成功后本地存放的文件路径]
`errorBlock`	下载失败的回调[errorCode:下载失败的错误码]
`cancelBlock`	用户取消了下载的回调

Discussion

下载消息内容中的媒体信息

用来获取媒体原文件时调用。如果本地缓存中包含此文件，则从本地缓存中直接获取，否则将从服务器端下载。

@remarks 多媒体下载

Declared In

RCIMClient.h

`– cancelDownloadMediaMessage:`

取消下载中的媒体信息

- (BOOL)cancelDownloadMediaMessage:(long)messageId

Parameters

`messageId`	媒体消息的messageId

Return Value

YES 表示取消成功，NO表示取消失败，即已经下载完成或者消息不存在。

@remarks 多媒体下载

Discussion

取消下载中的媒体信息

Declared In

RCIMClient.h

`– cancelDownloadMediaUrl:`

取消下载中的媒体信息

- (BOOL)cancelDownloadMediaUrl:(NSString *)mediaUrl

Parameters

`mediaUrl`	媒体消息 Url

Return Value

YES 表示取消成功，NO 表示取消失败，即已经下载完成或者消息不存在。

@remarks 多媒体下载

Discussion

取消下载中的媒体信息

Declared In

RCIMClient.h

`– sendDirectionalMessage:targetId:toUserIdList:content:pushContent:pushData:success:error:`

发送定向消息

- (RCMessage *)sendDirectionalMessage:(RCConversationType)conversationType targetId:(NSString *)targetId toUserIdList:(NSArray *)userIdList content:(RCMessageContent *)content pushContent:(NSString *)pushContent pushData:(NSString *)pushData success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode , long messageId ))errorBlock

Parameters

`conversationType`	发送消息的会话类型
`targetId`	发送消息的会话 ID
`userIdList`	接收消息的用户 ID 列表
`content`	消息的内容
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`successBlock`	消息发送成功的回调 [messageId:消息的 ID]
`errorBlock`	消息发送失败的回调 [errorCode:发送失败的错误码, messageId:消息的 ID]

Return Value

发送的消息实体

Discussion

发送定向消息

此方法用于在群组和讨论组中发送消息给其中的部分用户，其它用户不会收到这条消息。如果您使用 IMLib，可以使用此方法发送定向消息；如果您使用 IMKit，请使用 RCIM 中的同名方法发送定向消息，否则不会自动更新 UI。

Warning: 此方法目前仅支持群组和讨论组。

@remarks 消息操作

Declared In

RCIMClient.h

`– sendDirectionalMessage:toUserIdList:pushContent:pushData:successBlock:errorBlock:`

发送定向消息

- (RCMessage *)sendDirectionalMessage:(RCMessage *)message toUserIdList:(NSArray *)userIdList pushContent:(NSString *)pushContent pushData:(NSString *)pushData successBlock:(void ( ^ ) ( RCMessage *successMessage ))successBlock errorBlock:(void ( ^ ) ( RCErrorCode nErrorCode , RCMessage *errorMessage ))errorBlock

Parameters

`message`	消息实体
`userIdList`	接收消息的用户 ID 列表
`pushContent`	接收方离线时需要显示的远程推送内容
`pushData`	接收方离线时需要在远程推送中携带的非显示数据
`successBlock`	消息发送成功的回调 [successMessage:发送成功的消息]
`errorBlock`	消息发送失败的回调 [nErrorCode:发送失败的错误码,errorMessage:发送失败的消息]

Return Value

发送的消息实体

Discussion

发送定向消息

此方法用于在群组和讨论组中发送消息给其中的部分用户，其它用户不会收到这条消息。

Warning: 此方法目前仅支持群组和讨论组。

@remarks 消息操作

Declared In

RCIMClient.h

`– setReceiveMessageDelegate:object:`

设置 IMlib 的消息接收监听器

- (void)setReceiveMessageDelegate:(id<RCIMClientReceiveMessageDelegate>)delegate object:(id)userData

Parameters

`delegate`	IMLib 消息接收监听器
`userData`	用户自定义的监听器 Key 值，可以为 nil @discussion 设置 IMLib 的消息接收监听器请参考 RCIMClient 的 setReceiveMessageDelegate:object:方法。 userData 为您自定义的任意数据，SDK 会在回调的 onReceived:left:object:方法中传入作为 object 参数。您如果有设置多个监听，会只有最终的一个监听器起作用，您可以通过该 userData 值区分您设置的监听器。如果不需要直接设置为 nil 就可以。

delegate

IMLib 消息接收监听器

userData

用户自定义的监听器 Key 值，可以为 nil

@discussion 设置 IMLib 的消息接收监听器请参考 RCIMClient 的 setReceiveMessageDelegate:object:方法。

userData 为您自定义的任意数据，SDK 会在回调的 onReceived:left:object:方法中传入作为 object 参数。您如果有设置多个监听，会只有最终的一个监听器起作用，您可以通过该 userData 值区分您设置的监听器。如果不需要直接设置为 nil 就可以。

Discussion

设置 IMlib 的消息接收监听器

Warning: 如果您使用 IMlib，可以设置并实现此 Delegate 监听消息接收；如果您使用 IMKit，请使用 RCIM 中的 receiveMessageDelegate 监听消息接收，而不要使用此方法，否则会导致 IMKit 中无法自动更新 UI！

@remarks 功能设置

Declared In

RCIMClient.h

`– sendReadReceiptMessage:targetId:time:success:error:`

发送某个会话中消息阅读的回执

- (void)sendReadReceiptMessage:(RCConversationType)conversationType targetId:(NSString *)targetId time:(long long)timestamp success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`timestamp`	该会话中已阅读的最后一条消息的发送时间戳
`successBlock`	发送成功的回调
`errorBlock`	发送失败的回调[nErrorCode: 失败的错误码]

Discussion

发送某个会话中消息阅读的回执

此接口只支持单聊, 如果使用 IMLib 可以注册监听 RCLibDispatchReadReceiptNotification 通知,使用 IMKit 直接设置RCIM.h 中的 enabledReadReceiptConversationTypeList。

Warning: 目前仅支持单聊。

@remarks 高级功能

Declared In

RCIMClient.h

`– sendReadReceiptRequest:success:error:`

请求消息阅读回执

- (void)sendReadReceiptRequest:(RCMessage *)message success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`message`	要求阅读回执的消息
`successBlock`	请求成功的回调
`errorBlock`	请求失败的回调[nErrorCode: 失败的错误码]

Discussion

请求消息阅读回执

通过此接口，可以要求阅读了这条消息的用户发送阅读回执。

@remarks 高级功能

Declared In

RCIMClient.h

`– sendReadReceiptResponse:targetId:messageList:success:error:`

发送阅读回执

- (void)sendReadReceiptResponse:(RCConversationType)conversationType targetId:(NSString *)targetId messageList:(NSArray<RCMessage*> *)messageList success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`messageList`	已经阅读了的消息列表
`successBlock`	发送成功的回调
`errorBlock`	发送失败的回调[nErrorCode: 失败的错误码]

Discussion

发送阅读回执

当用户阅读了需要阅读回执的消息，可以通过此接口发送阅读回执，消息的发送方即可直接知道那些人已经阅读。

@remarks 高级功能

Declared In

RCIMClient.h

`– syncConversationReadStatus:targetId:time:success:error:`

同步会话阅读状态（把指定会话里所有发送时间早于 timestamp 的消息置为已读）

- (void)syncConversationReadStatus:(RCConversationType)conversationType targetId:(NSString *)targetId time:(long long)timestamp success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`timestamp`	已经阅读的最后一条消息的 Unix 时间戳(毫秒)
`successBlock`	同步成功的回调
`errorBlock`	同步失败的回调[nErrorCode: 失败的错误码] @remarks 高级功能

Discussion

同步会话阅读状态（把指定会话里所有发送时间早于 timestamp 的消息置为已读）

Declared In

RCIMClient.h

`– recallMessage:pushContent:success:error:`

撤回消息

- (void)recallMessage:(RCMessage *)message pushContent:(NSString *)pushContent success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode errorcode ))errorBlock

Parameters

`message`	需要撤回的消息
`pushContent`	当下发 push 消息时，在通知栏里会显示这个字段，不设置将使用融云默认推送内容
`successBlock`	撤回成功的回调 [messageId:撤回的消息 ID，该消息已经变更为新的消息]
`errorBlock`	撤回失败的回调 [errorCode:撤回失败错误码]

Discussion

撤回消息

Warning: 仅支持单聊、群组和讨论组。

@remarks 高级功能

Declared In

RCIMClient.h

`– recallMessage:success:error:`

撤回消息

- (void)recallMessage:(RCMessage *)message success:(void ( ^ ) ( long messageId ))successBlock error:(void ( ^ ) ( RCErrorCode errorcode ))errorBlock

Parameters

`message`	需要撤回的消息
`successBlock`	撤回成功的回调 [messageId:撤回的消息 ID，该消息已经变更为新的消息]
`errorBlock`	撤回失败的回调 [errorCode:撤回失败错误码] @remarks 高级功能

Discussion

撤回消息

Declared In

RCIMClient.h

`– getLatestMessages:targetId:count:`

获取某个会话中指定数量的最新消息实体

- (NSArray *)getLatestMessages:(RCConversationType)conversationType targetId:(NSString *)targetId count:(int)count

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`count`	需要获取的消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 此方法会获取该会话中指定数量的最新消息实体，返回的消息实体按照时间从新到旧排列。如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。

@remarks 消息操作

Discussion

获取某个会话中指定数量的最新消息实体

Declared In

RCIMClient.h

`– getHistoryMessages:targetId:oldestMessageId:count:`

获取会话中，从指定消息之前、指定数量的最新消息实体

- (NSArray *)getHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId oldestMessageId:(long)oldestMessageId count:(int)count

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`oldestMessageId`	截止的消息 ID
`count`	需要获取的消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 此方法会获取该会话中，oldestMessageId 之前的、指定数量的最新消息实体，返回的消息实体按照时间从新到旧排列。返回的消息中不包含 oldestMessageId 对应那条消息，如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。如： oldestMessageId 为 10，count 为 2，会返回 messageId 为 9 和 8 的 RCMessage 对象列表。

@remarks 消息操作

Discussion

获取会话中，从指定消息之前、指定数量的最新消息实体

Declared In

RCIMClient.h

`– getHistoryMessages:targetId:objectName:oldestMessageId:count:`

获取会话中，从指定消息之前、指定数量的、指定消息类型的最新消息实体

- (NSArray *)getHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId objectName:(NSString *)objectName oldestMessageId:(long)oldestMessageId count:(int)count

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`objectName`	消息内容的类型名，如果想取全部类型的消息请传 nil
`oldestMessageId`	截止的消息 ID
`count`	需要获取的消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 此方法会获取该会话中，oldestMessageId 之前的、指定数量和消息类型的最新消息实体，返回的消息实体按照时间从新到旧排列。返回的消息中不包含 oldestMessageId 对应的那条消息，如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。如：oldestMessageId 为 10，count 为 2，会返回 messageId 为 9 和 8 的 RCMessage 对象列表。

@remarks 消息操作

Discussion

获取会话中，从指定消息之前、指定数量的、指定消息类型的最新消息实体

Declared In

RCIMClient.h

`– getHistoryMessages:targetId:objectName:baseMessageId:isForward:count:`

获取会话中，指定消息、指定数量、指定消息类型、向前或向后查找的消息实体列表

- (NSArray *)getHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId objectName:(NSString *)objectName baseMessageId:(long)baseMessageId isForward:(BOOL)isForward count:(int)count

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`objectName`	消息内容的类型名，如果想取全部类型的消息请传 nil
`baseMessageId`	当前的消息 ID
`isForward`	查询方向 true 为向前，false 为向后
`count`	需要获取的消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 此方法会获取该会话中，baseMessageId 之前或之后的、指定数量、消息类型和查询方向的最新消息实体，返回的消息实体按照时间从新到旧排列。返回的消息中不包含 baseMessageId 对应的那条消息，如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。

@remarks 消息操作

Discussion

获取会话中，指定消息、指定数量、指定消息类型、向前或向后查找的消息实体列表

Declared In

RCIMClient.h

`– getHistoryMessages:targetId:objectNames:sentTime:isForward:count:`

获取会话中，指定时间、指定数量、指定消息类型（多个）、向前或向后查找的消息实体列表

- (NSArray *)getHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId objectNames:(NSArray *)objectNames sentTime:(long long)sentTime isForward:(BOOL)isForward count:(int)count

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`objectNames`	消息内容的类型名称列表
`sentTime`	当前的消息时间戳
`isForward`	查询方向 true 为向前，false 为向后
`count`	需要获取的消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 此方法会获取该会话中，sentTime 之前或之后的、指定数量、指定消息类型（多个）的消息实体列表，返回的消息实体按照时间从新到旧排列。返回的消息中不包含 sentTime 对应的那条消息，如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。

@remarks 消息操作

Discussion

获取会话中，指定时间、指定数量、指定消息类型（多个）、向前或向后查找的消息实体列表

Declared In

RCIMClient.h

`– getHistoryMessages:targetId:sentTime:beforeCount:afterCount:`

在会话中搜索指定消息的前 beforeCount 数量和后 afterCount 数量的消息。返回的消息列表中会包含指定的消息。消息列表时间顺序从新到旧。

- (NSArray *)getHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId sentTime:(long long)sentTime beforeCount:(int)beforeCount afterCount:(int)afterCount

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`sentTime`	消息的发送时间
`beforeCount`	指定消息的前部分消息数量
`afterCount`	指定消息的后部分消息数量

Return Value

消息实体 RCMessage 对象列表

@discussion 获取该会话的这条消息及这条消息前 beforeCount 条和后 afterCount 条消息,如前后消息不够则返回实际数量的消息。

@remarks 消息操作

Discussion

在会话中搜索指定消息的前 beforeCount 数量和后 afterCount 数量的消息。返回的消息列表中会包含指定的消息。消息列表时间顺序从新到旧。

Declared In

RCIMClient.h

`– clearRemoteHistoryMessages:targetId:recordTime:success:error:`

从服务器端清除历史消息

- (void)clearRemoteHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId recordTime:(long long)recordTime success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`recordTime`	清除消息时间戳，【0 <= recordTime <= 当前会话最后一条消息的 sentTime,0 清除所有消息，其他值清除小于等于 recordTime 的消息】
`successBlock`	获取成功的回调
`errorBlock`	获取失败的回调 [status:清除失败的错误码] @discussion 此方法从服务器端清除历史消息，但是必须先开通历史消息云存储功能。例如，您不想从服务器上获取更多的历史消息，通过指定 recordTime 清除成功后只能获取该时间戳之后的历史消息。 @remarks 消息操作

Discussion

从服务器端清除历史消息

Declared In

RCIMClient.h

`– clearHistoryMessages:targetId:recordTime:clearRemote:success:error:`

清除历史消息

- (void)clearHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId recordTime:(long long)recordTime clearRemote:(BOOL)clearRemote success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`recordTime`	清除消息时间戳，【0 <= recordTime <= 当前会话最后一条消息的 sentTime,0 清除所有消息，其他值清除小于等于 recordTime 的消息】
`clearRemote`	是否同时删除服务端消息
`successBlock`	获取成功的回调
`errorBlock`	获取失败的回调 [ status:清除失败的错误码] @discussion 此方法可以清除服务器端历史消息和本地消息，如果清除服务器端消息必须先开通历史消息云存储功能。例如，您不想从服务器上获取更多的历史消息，通过指定 recordTime 并设置 clearRemote 为 YES 清除消息，成功后只能获取该时间戳之后的历史消息。如果 clearRemote 传 NO，只会清除本地消息。 @remarks 消息操作

Discussion

清除历史消息

Declared In

RCIMClient.h

`– getRemoteHistoryMessages:targetId:recordTime:count:success:error:`

从服务器端获取之前的历史消息

- (void)getRemoteHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId recordTime:(long long)recordTime count:(int)count success:(void ( ^ ) ( NSArray *messages , BOOL isRemaining ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`recordTime`	截止的消息发送时间戳，毫秒
`count`	需要获取的消息数量， 0 < count <= 20
`successBlock`	获取成功的回调 [messages:获取到的历史消息数组, isRemaining 是否还有剩余消息 YES 表示还有剩余，NO 表示无剩余]
`errorBlock`	获取失败的回调 [status:获取失败的错误码] @discussion 此方法从服务器端获取之前的历史消息，但是必须先开通历史消息云存储功能。例如，本地会话中有10条消息，您想拉取更多保存在服务器的消息的话，recordTime 应传入最早的消息的发送时间戳，count 传入 1~20 之间的数值。

Discussion

从服务器端获取之前的历史消息

本地数据库可以查到的消息，该接口不会再返回，所以建议先用 getHistoryMessages 相关接口取本地历史消息，本地消息取完之后再通过该接口获取远端历史消息

@remarks 消息操作

Declared In

RCIMClient.h

`– getRemoteHistoryMessages:targetId:option:success:error:`

从服务器端获取之前的历史消息

- (void)getRemoteHistoryMessages:(RCConversationType)conversationType targetId:(NSString *)targetId option:(RCRemoteHistoryMsgOption *)option success:(void ( ^ ) ( NSArray *messages , BOOL isRemaining ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`option`	可配置的参数
`successBlock`	获取成功的回调 [messages:获取到的历史消息数组, isRemaining 是否还有剩余消息 YES 表示还有剩余，NO 表示无剩余]
`errorBlock`	获取失败的回调 [status:获取失败的错误码] @discussion 此方法从服务器端获取之前的历史消息，但是必须先开通历史消息云存储功能。例如，本地会话中有 10 条消息，您想拉取更多保存在服务器的消息的话，recordTime 应传入最早的消息的发送时间戳，count 传入 1~20 之间的数值。 @remarks 消息操作

Discussion

从服务器端获取之前的历史消息

Declared In

RCIMClient.h

`– getRemoteChatroomHistoryMessages:recordTime:count:order:success:error:`

从服务器端获取聊天室的历史消息

- (void)getRemoteChatroomHistoryMessages:(NSString *)targetId recordTime:(long long)recordTime count:(int)count order:(RCTimestampOrder)order success:(void ( ^ ) ( NSArray *messages , long long syncTime ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`targetId`	聊天室 ID
`recordTime`	起始的消息发送时间戳，毫秒
`count`	需要获取的消息数量， 0 < count <= 200
`order`	拉取顺序，RC_Timestamp_Desc:倒序，RC_Timestamp_ASC:正序
`successBlock`	获取成功的回调 [messages:获取到的历史消息数组, syncTime:下次拉取消息的时间戳]
`errorBlock`	获取失败的回调 [status:获取失败的错误码] @discussion 此方法从服务器端获取聊天室的历史消息，但是必须先开通聊天室消息云存储功能。指定开始时间,比如 2016 年 9 月 1 日 10 点(1472695200000), 默认是0(正序:从存储的第一条消息开始拉取,倒序:从存储的最后一条消息开始拉取) @remarks 消息操作

Discussion

从服务器端获取聊天室的历史消息

Declared In

RCIMClient.h

`– getUnreadMentionedMessages:targetId:`

获取会话中@提醒自己的消息

- (NSArray *)getUnreadMentionedMessages:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

conversationType

会话类型

targetId

会话 ID

@discussion 此方法从本地获取被@提醒的消息(最多返回 10 条信息)

Discussion

获取会话中@提醒自己的消息

Warning: 使用 IMKit 注意在进入会话页面前调用，否则在进入会话清除未读数的接口 clearMessagesUnreadStatus: targetId: 以及设置消息接收状态接口 setMessageReceivedStatus:receivedStatus:会同步清除被提示信息状态。

@remarks 高级功能

Declared In

RCIMClient.h

`– getMessageSendTime:`

获取消息的发送时间（Unix 时间戳、毫秒）

- (long long)getMessageSendTime:(long)messageId

Parameters

`messageId`	消息 ID

Return Value

消息的发送时间（Unix 时间戳、毫秒）

@remarks 消息操作

Discussion

获取消息的发送时间（Unix 时间戳、毫秒）

Declared In

RCIMClient.h

`– getMessage:`

通过 messageId 获取消息实体

- (RCMessage *)getMessage:(long)messageId

Parameters

`messageId`	消息 ID（数据库索引唯一值）

Return Value

通过消息 ID 获取到的消息实体，当获取失败的时候，会返回 nil。

@remarks 消息操作

Discussion

通过 messageId 获取消息实体

Declared In

RCIMClient.h

`– getMessageByUId:`

通过全局唯一 ID 获取消息实体

- (RCMessage *)getMessageByUId:(NSString *)messageUId

Parameters

`messageUId`	全局唯一 ID（服务器消息唯一 ID）

Return Value

通过全局唯一ID获取到的消息实体，当获取失败的时候，会返回 nil。

@remarks 消息操作

Discussion

通过全局唯一 ID 获取消息实体

Declared In

RCIMClient.h

`– getFirstUnreadMessage:targetId:`

获取会话里第一条未读消息。

- (RCMessage *)getFirstUnreadMessage:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话 ID

Return Value

第一条未读消息的实体。 @remarks 消息操作

Discussion

获取会话里第一条未读消息。

Declared In

RCIMClient.h

`– deleteMessages:`

删除消息

- (BOOL)deleteMessages:(NSArray<NSNumber*> *)messageIds

Parameters

`messageIds`	消息 ID 的列表，元素需要为 NSNumber 类型

Return Value

是否删除成功

@remarks 消息操作

Discussion

删除消息

Declared In

RCIMClient.h

`– deleteMessages:targetId:success:error:`

删除某个会话中的所有消息

- (void)deleteMessages:(RCConversationType)conversationType targetId:(NSString *)targetId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型，不支持聊天室
`targetId`	会话 ID
`successBlock`	成功的回调
`errorBlock`	失败的回调

Discussion

删除某个会话中的所有消息

此方法删除数据库中该会话的消息记录，同时会整理压缩数据库，减少占用空间

@remarks 消息操作

Declared In

RCIMClient.h

`– deleteRemoteMessage:targetId:messages:success:error:`

批量删除某个会话中的指定远端消息（同时删除对应的本地消息）

- (void)deleteRemoteMessage:(RCConversationType)conversationType targetId:(NSString *)targetId messages:(NSArray<RCMessage*> *)messages success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型，不支持聊天室
`targetId`	目标会话ID
`messages`	将被删除的消息列表
`successBlock`	成功的回调
`errorBlock`	失败的回调

Discussion

批量删除某个会话中的指定远端消息（同时删除对应的本地消息）

此方法会同时删除远端和本地消息。一次批量操作仅支持删除属于同一个会话的消息，请确保消息列表中的所有消息来自同一会话一次最多删除 100 条消息。

@remarks 消息操作

Declared In

RCIMClient.h

`– clearMessages:targetId:`

删除某个会话中的所有消息

- (BOOL)clearMessages:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话 ID

Return Value

是否删除成功

@remarks 消息操作

Discussion

删除某个会话中的所有消息

Declared In

RCIMClient.h

`– setMessageExtra:value:`

设置消息的附加信息

- (BOOL)setMessageExtra:(long)messageId value:(NSString *)value

Parameters

`messageId`	消息 ID
`value`	附加信息，最大 1024 字节

Return Value

是否设置成功

Discussion

设置消息的附加信息

用于扩展消息的使用场景。只能用于本地使用，无法同步到远端。

@remarks 消息操作

Declared In

RCIMClient.h

`– setMessageReceivedStatus:receivedStatus:`

设置消息的接收状态

- (BOOL)setMessageReceivedStatus:(long)messageId receivedStatus:(RCReceivedStatus)receivedStatus

Parameters

`messageId`	消息 ID
`receivedStatus`	消息的接收状态

Return Value

是否设置成功

Discussion

设置消息的接收状态

用于 UI 展示消息为已读，已下载等状态。

@remarks 消息操作

Declared In

RCIMClient.h

`– setMessageSentStatus:sentStatus:`

设置消息的发送状态

- (BOOL)setMessageSentStatus:(long)messageId sentStatus:(RCSentStatus)sentStatus

Parameters

`messageId`	消息 ID
`sentStatus`	消息的发送状态

Return Value

是否设置成功

Discussion

设置消息的发送状态

用于 UI 展示消息为正在发送，对方已接收等状态。

@remarks 消息操作

Declared In

RCIMClient.h

`– messageBeginDestruct:`

开始焚烧消息（目前仅支持单聊）

- (void)messageBeginDestruct:(RCMessage *)message

Parameters

`message`	消息类

Discussion

开始焚烧消息（目前仅支持单聊）

仅限接收方调用

@remarks 高级功能

Declared In

RCIMClient.h

`– messageStopDestruct:`

停止焚烧消息（目前仅支持单聊）

- (void)messageStopDestruct:(RCMessage *)message

Parameters

`message`	消息类

Discussion

停止焚烧消息（目前仅支持单聊）

仅限接收方调用

@remarks 高级功能

Declared In

RCIMClient.h

`– getConversationList:`

获取会话列表

- (NSArray *)getConversationList:(NSArray *)conversationTypeList

Parameters

`conversationTypeList`	会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 NSArray)

Return Value

会话 RCConversation 的列表

Discussion

获取会话列表

此方法会从本地数据库中，读取会话列表。返回的会话列表按照时间从前往后排列，如果有置顶的会话，则置顶的会话会排列在前面。

当您的会话较多且没有清理机制的时候，强烈建议您使用 getConversationList: count: startTime: 分页拉取会话列表,否则有可能造成内存过大。

@remarks 会话列表

Declared In

RCIMClient.h

`– getConversationList:count:startTime:`

分页获取会话列表

- (NSArray *)getConversationList:(NSArray *)conversationTypeList count:(int)count startTime:(long long)startTime

Parameters

`conversationTypeList`	会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 NSArray)
`count`	获取的数量（当实际取回的会话数量小于 count 值时，表明已取完数据）
`startTime`	会话的时间戳（获取这个时间戳之前的会话列表，0表示从最新开始获取）

Return Value

会话 RCConversation 的列表

Discussion

分页获取会话列表

此方法会从本地数据库中，读取会话列表。返回的会话列表按照时间从前往后排列，如果有置顶的会话，则置顶的会话会排列在前面。

@remarks 会话列表

Declared In

RCIMClient.h

`– getConversation:targetId:`

获取单个会话数据

- (RCConversation *)getConversation:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话 ID

Return Value

会话的对象

@remarks 会话

Discussion

获取单个会话数据

Declared In

RCIMClient.h

`– getMessageCount:targetId:`

获取会话中的消息数量

- (int)getMessageCount:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话 ID

Return Value

会话中的消息数量

Discussion

获取会话中的消息数量

-1 表示获取消息数量出错。

@remarks 会话

Declared In

RCIMClient.h

`– clearConversations:`

删除指定类型的会话

- (BOOL)clearConversations:(NSArray *)conversationTypeList

Parameters

`conversationTypeList`	会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 NSArray)

Return Value

是否删除成功

Discussion

删除指定类型的会话

此方法会从本地存储中删除该会话，同时删除会话中的消息。

@remarks 会话

Declared In

RCIMClient.h

`– removeConversation:targetId:`

从本地存储中删除会话

- (BOOL)removeConversation:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话 ID

Return Value

是否删除成功

@discussion 此方法会从本地存储中删除该会话，但是不会删除会话中的消息。如果此会话中有新的消息，该会话将重新在会话列表中显示，并显示最近的历史消息。

@remarks 会话

Discussion

从本地存储中删除会话

Declared In

RCIMClient.h

`– setConversationToTop:targetId:isTop:`

设置会话的置顶状态

- (BOOL)setConversationToTop:(RCConversationType)conversationType targetId:(NSString *)targetId isTop:(BOOL)isTop

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`isTop`	是否置顶

Return Value

设置是否成功

Discussion

设置会话的置顶状态

会话不存在时设置置顶，会在会话列表生成会话。

@remarks 会话

Declared In

RCIMClient.h

`– getTopConversationList:`

获取置顶的会话列表

- (NSArray<RCConversation*> *)getTopConversationList:(NSArray *)conversationTypeList

Parameters

`conversationTypeList`	会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 NSArray)

Return Value

置顶的会话 RCConversation 的列表

Discussion

获取置顶的会话列表

此方法会从本地数据库中，读取置顶的会话列表。

@remarks 会话列表

Declared In

RCIMClient.h

`– getTextMessageDraft:targetId:`

获取会话中的草稿信息（用户输入但未发送的暂存消息）

- (NSString *)getTextMessageDraft:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话目标 ID

Return Value

该会话中的草稿

@remarks 会话

Discussion

获取会话中的草稿信息（用户输入但未发送的暂存消息）

Declared In

RCIMClient.h

`– saveTextMessageDraft:targetId:content:`

保存草稿信息（用户输入但未发送的暂存消息）

- (BOOL)saveTextMessageDraft:(RCConversationType)conversationType targetId:(NSString *)targetId content:(NSString *)content

Parameters

`conversationType`	会话类型
`targetId`	会话目标 ID
`content`	草稿信息

Return Value

是否保存成功

@remarks 会话

Discussion

保存草稿信息（用户输入但未发送的暂存消息）

Declared In

RCIMClient.h

`– clearTextMessageDraft:targetId:`

删除会话中的草稿信息（用户输入但未发送的暂存消息）

- (BOOL)clearTextMessageDraft:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话目标 ID

Return Value

是否删除成功

@remarks 会话

Discussion

删除会话中的草稿信息（用户输入但未发送的暂存消息）

Declared In

RCIMClient.h

`– getTotalUnreadCount`

获取所有的未读消息数（聊天室会话除外）

- (int)getTotalUnreadCount

Return Value

所有的未读消息数

@remarks 会话

Discussion

获取所有的未读消息数（聊天室会话除外）

Declared In

RCIMClient.h

`– getUnreadCount:targetId:`

获取某个会话内的未读消息数（聊天室会话除外）

- (int)getUnreadCount:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型
`targetId`	会话目标 ID

Return Value

该会话内的未读消息数

@remarks 会话

Discussion

获取某个会话内的未读消息数（聊天室会话除外）

Declared In

RCIMClient.h

`– getTotalUnreadCount:`

获取某些会话的总未读消息数（聊天室会话除外）

- (int)getTotalUnreadCount:(NSArray<RCConversation*> *)conversations

Parameters

`conversations`	会话列表（ RCConversation 对象只需要 conversationType 和 targetId ）

Return Value

传入会话列表的未读消息数

@remarks 会话

Discussion

获取某些会话的总未读消息数（聊天室会话除外）

Declared In

RCIMClient.h

`– getUnreadCount:containBlocked:`

获取某些类型的会话中所有的未读消息数（聊天室会话除外）

- (int)getUnreadCount:(NSArray *)conversationTypes containBlocked:(bool)isContain

Parameters

`conversationTypes`	会话类型的数组
`isContain`	是否包含免打扰消息的未读数

Return Value

该类型的会话中所有的未读消息数

@remarks 会话

Discussion

获取某些类型的会话中所有的未读消息数（聊天室会话除外）

Declared In

RCIMClient.h

`– getUnreadCount:`

获取某个类型的会话中所有的未读消息数（聊天室会话除外）

- (int)getUnreadCount:(NSArray *)conversationTypes

Parameters

`conversationTypes`	会话类型的数组

Return Value

该类型的会话中所有的未读消息数

@remarks 会话

Discussion

获取某个类型的会话中所有的未读消息数（聊天室会话除外）

Declared In

RCIMClient.h

`– getUnreadMentionedCount:`

获取某个类型的会话中所有未读的被@的消息数

- (int)getUnreadMentionedCount:(NSArray *)conversationTypes

Parameters

`conversationTypes`	会话类型的数组

Return Value

该类型的会话中所有未读的被@的消息数

@remarks 会话

Discussion

获取某个类型的会话中所有未读的被@的消息数

Declared In

RCIMClient.h

`– clearMessagesUnreadStatus:targetId:`

清除某个会话中的未读消息数

- (BOOL)clearMessagesUnreadStatus:(RCConversationType)conversationType targetId:(NSString *)targetId

Parameters

`conversationType`	会话类型，不支持聊天室
`targetId`	会话 ID

Return Value

是否清除成功

@remarks 会话

Discussion

清除某个会话中的未读消息数

Declared In

RCIMClient.h

`– clearMessagesUnreadStatus:targetId:time:`

清除某个会话中的未读消息数（该会话在时间戳 timestamp 之前的消息将被置成已读。）

- (BOOL)clearMessagesUnreadStatus:(RCConversationType)conversationType targetId:(NSString *)targetId time:(long long)timestamp

Parameters

`conversationType`	会话类型，不支持聊天室
`targetId`	会话 ID
`timestamp`	该会话已阅读的最后一条消息的发送时间戳

Return Value

是否清除成功

@remarks 会话

Discussion

清除某个会话中的未读消息数（该会话在时间戳 timestamp 之前的消息将被置成已读。）

Declared In

RCIMClient.h

`– setConversationNotificationStatus:targetId:isBlocked:success:error:`

设置会话的消息提醒状态

- (void)setConversationNotificationStatus:(RCConversationType)conversationType targetId:(NSString *)targetId isBlocked:(BOOL)isBlocked success:(void ( ^ ) ( RCConversationNotificationStatus nStatus ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`isBlocked`	是否屏蔽消息提醒
`successBlock`	设置成功的回调 [nStatus:会话设置的消息提醒状态]
`errorBlock`	设置失败的回调 [status:设置失败的错误码] @discussion 如果您使用 IMLib，此方法会屏蔽该会话的远程推送；如果您使用IMKit，此方法会屏蔽该会话的所有提醒（远程推送、本地通知、前台提示音）,该接口不支持聊天室。 @remarks 会话

Discussion

设置会话的消息提醒状态

Declared In

RCIMClient.h

`– getConversationNotificationStatus:targetId:success:error:`

查询会话的消息提醒状态

- (void)getConversationNotificationStatus:(RCConversationType)conversationType targetId:(NSString *)targetId success:(void ( ^ ) ( RCConversationNotificationStatus nStatus ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`conversationType`	会话类型（不支持聊天室，聊天室是不接受会话消息提醒的）
`targetId`	会话 ID
`successBlock`	查询成功的回调 [nStatus:会话设置的消息提醒状态]
`errorBlock`	查询失败的回调 [status:设置失败的错误码] @remarks 会话

Discussion

查询会话的消息提醒状态

Declared In

RCIMClient.h

`– getBlockedConversationList:`

获取消息免打扰会话列表

- (NSArray<RCConversation*> *)getBlockedConversationList:(NSArray *)conversationTypeList

Parameters

`conversationTypeList`	会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 NSArray)

Return Value

消息免打扰会话 RCConversation 的列表

Discussion

获取消息免打扰会话列表

此方法会从本地数据库中，读取消息免打扰会话列表。

@remarks 会话列表

Declared In

RCIMClient.h

`– setNotificationQuietHours:spanMins:success:error:`

全局屏蔽某个时间段的消息提醒

- (void)setNotificationQuietHours:(NSString *)startTime spanMins:(int)spanMins success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`startTime`	开始消息免打扰时间，格式为 HH:MM:SS
`spanMins`	需要消息免打扰分钟数，0 < spanMins < 1440（比如，您设置的起始时间是 00：00，结束时间为 23：59，则 spanMins 为 23 * 60 + 59 = 1439 分钟。）
`successBlock`	屏蔽成功的回调
`errorBlock`	屏蔽失败的回调 [status:屏蔽失败的错误码]

Discussion

全局屏蔽某个时间段的消息提醒

此方法设置的屏蔽时间会在每天该时间段时生效。如果您使用 IMLib，此方法会屏蔽该会话在该时间段的远程推送；如果您使用 IMKit，此方法会屏蔽该会话在该时间段的所有提醒（远程推送、本地通知、前台提示音）。

@remarks 会话

Declared In

RCIMClient.h

`– removeNotificationQuietHours:error:`

删除已设置的全局时间段消息提醒屏蔽

- (void)removeNotificationQuietHours:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

successBlock

删除屏蔽成功的回调

errorBlock

删除屏蔽失败的回调 [status:失败的错误码]

@remarks 会话

Discussion

删除已设置的全局时间段消息提醒屏蔽

Declared In

RCIMClient.h

`– getNotificationQuietHours:error:`

查询已设置的全局时间段消息提醒屏蔽

- (void)getNotificationQuietHours:(void ( ^ ) ( NSString *startTime , int spansMin ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

successBlock

屏蔽成功的回调 [startTime:已设置的屏蔽开始时间, spansMin:已设置的屏蔽时间分钟数，0 < spansMin < 1440]

errorBlock

查询失败的回调 [status:查询失败的错误码]

@remarks 会话

Discussion

查询已设置的全局时间段消息提醒屏蔽

Declared In

RCIMClient.h

`– setRCTypingStatusDelegate:`

设置输入状态的监听器

- (void)setRCTypingStatusDelegate:(id<RCTypingStatusDelegate>)delegate

Parameters

`delegate`	IMLib 输入状态的的监听器

Discussion

设置输入状态的监听器

Warning: 目前仅支持单聊。

@remarks 功能设置

Declared In

RCIMClient.h

`– sendTypingStatus:targetId:contentType:`

向会话中发送正在输入的状态

- (void)sendTypingStatus:(RCConversationType)conversationType targetId:(NSString *)targetId contentType:(NSString *)objectName

Parameters

conversationType

会话类型

targetId

会话目标 ID

objectName

正在输入的消息的类型名

@discussion contentType 为用户当前正在编辑的消息类型名，即 RCMessageContent 中 getObjectName 的返回值。如文本消息，应该传类型名"RC:TxtMsg"。

Discussion

向会话中发送正在输入的状态

Warning: 目前仅支持单聊。

@remarks 高级功能

Declared In

RCIMClient.h

`– addToBlacklist:success:error:`

将某个用户加入黑名单

- (void)addToBlacklist:(NSString *)userId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`userId`	需要加入黑名单的用户 ID
`successBlock`	加入黑名单成功的回调
`errorBlock`	加入黑名单失败的回调 [status:失败的错误码]

Discussion

将某个用户加入黑名单

将对方加入黑名单后，对方再发消息时，就会提示“您的消息已经发出, 但被对方拒收”。但您仍然可以给对方发送消息。

@remarks 高级功能

Declared In

RCIMClient.h

`– removeFromBlacklist:success:error:`

将某个用户移出黑名单

- (void)removeFromBlacklist:(NSString *)userId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

userId

需要移出黑名单的用户 ID

successBlock

移出黑名单成功的回调

errorBlock

移出黑名单失败的回调[status:失败的错误码]

@remarks 高级功能

Discussion

将某个用户移出黑名单

Declared In

RCIMClient.h

`– getBlacklistStatus:success:error:`

查询某个用户是否已经在黑名单中

- (void)getBlacklistStatus:(NSString *)userId success:(void ( ^ ) ( int bizStatus ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

userId

需要查询的用户 ID

successBlock

查询成功的回调 [bizStatus:该用户是否在黑名单中。0 表示已经在黑名单中，101 表示不在黑名单中]

errorBlock

查询失败的回调 [status:失败的错误码]

@remarks 高级功能

Discussion

查询某个用户是否已经在黑名单中

Declared In

RCIMClient.h

`– getBlacklist:error:`

查询已经设置的黑名单列表

- (void)getBlacklist:(void ( ^ ) ( NSArray *blockUserIds ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

successBlock

查询成功的回调 [blockUserIds:已经设置的黑名单中的用户 ID 列表]

errorBlock

查询失败的回调 [status:失败的错误码]

@remarks 高级功能

Discussion

查询已经设置的黑名单列表

Declared In

RCIMClient.h

`– createDiscussion:userIdList:success:error:`

创建讨论组

- (void)createDiscussion:(NSString *)name userIdList:(NSArray *)userIdList success:(void ( ^ ) ( RCDiscussion *discussion ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`name`	讨论组名称
`userIdList`	用户 ID 的列表
`successBlock`	创建讨论组成功的回调 [discussion:创建成功返回的讨论组对象]
`errorBlock`	创建讨论组失败的回调 [status:创建失败的错误码] @remarks 会话

Discussion

创建讨论组

Declared In

RCIMClient.h

`– addMemberToDiscussion:userIdList:success:error:`

讨论组加人，将用户加入讨论组

- (void)addMemberToDiscussion:(NSString *)discussionId userIdList:(NSArray *)userIdList success:(void ( ^ ) ( RCDiscussion *discussion ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`discussionId`	讨论组 ID
`userIdList`	需要加入的用户 ID 列表
`successBlock`	讨论组加人成功的回调 [discussion:讨论组加人成功返回的讨论组对象]
`errorBlock`	讨论组加人失败的回调 [status:讨论组加人失败的错误码]

Discussion

讨论组加人，将用户加入讨论组

设置的讨论组名称长度不能超过 40 个字符，否则将会截断为前 40 个字符。

@remarks 会话

Declared In

RCIMClient.h

`– removeMemberFromDiscussion:userId:success:error:`

讨论组踢人，将用户移出讨论组

- (void)removeMemberFromDiscussion:(NSString *)discussionId userId:(NSString *)userId success:(void ( ^ ) ( RCDiscussion *discussion ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`discussionId`	讨论组 ID
`userId`	需要移出的用户 ID
`successBlock`	讨论组踢人成功的回调 [discussion:讨论组踢人成功返回的讨论组对象]
`errorBlock`	讨论组踢人失败的回调 [status:讨论组踢人失败的错误码] @discussion 如果当前登录用户不是此讨论组的创建者并且此讨论组没有开放加人权限，则会返回错误。

Discussion

讨论组踢人，将用户移出讨论组

Warning: 不能使用此接口将自己移除，否则会返回错误。如果您需要退出该讨论组，可以使用-quitDiscussion:success:error:方法。

@remarks 会话

Declared In

RCIMClient.h

`– quitDiscussion:success:error:`

退出当前讨论组

- (void)quitDiscussion:(NSString *)discussionId success:(void ( ^ ) ( RCDiscussion *discussion ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

discussionId

讨论组 ID

successBlock

退出成功的回调 [discussion:退出成功返回的讨论组对象]

errorBlock

退出失败的回调 [status:退出失败的错误码]

@remarks 会话

Discussion

退出当前讨论组

Declared In

RCIMClient.h

`– getDiscussion:success:error:`

获取讨论组的信息

- (void)getDiscussion:(NSString *)discussionId success:(void ( ^ ) ( RCDiscussion *discussion ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

discussionId

需要获取信息的讨论组 ID

successBlock

获取讨论组信息成功的回调 [discussion:获取的讨论组信息]

errorBlock

获取讨论组信息失败的回调 [status:获取讨论组信息失败的错误码]

@remarks 会话

Discussion

获取讨论组的信息

Declared In

RCIMClient.h

`– setDiscussionName:name:success:error:`

设置讨论组名称

- (void)setDiscussionName:(NSString *)discussionId name:(NSString *)discussionName success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`discussionId`	需要设置的讨论组 ID
`discussionName`	需要设置的讨论组名称，discussionName 长度<=40
`successBlock`	设置成功的回调
`errorBlock`	设置失败的回调 [status:设置失败的错误码]

Discussion

设置讨论组名称

设置的讨论组名称长度不能超过 40 个字符，否则将会截断为前 40 个字符。

@remarks 会话

Declared In

RCIMClient.h

`– setDiscussionInviteStatus:isOpen:success:error:`

设置讨论组是否开放加人权限

- (void)setDiscussionInviteStatus:(NSString *)discussionId isOpen:(BOOL)isOpen success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`discussionId`	讨论组 ID
`isOpen`	是否开放加人权限
`successBlock`	设置成功的回调
`errorBlock`	设置失败的回调[status:设置失败的错误码]

Discussion

设置讨论组是否开放加人权限

讨论组默认开放加人权限，即所有成员都可以加人。如果关闭加人权限之后，只有讨论组的创建者有加人权限。

@remarks 会话

Declared In

RCIMClient.h

`– joinChatRoom:messageCount:success:error:`

加入聊天室（如果聊天室不存在则会创建）

- (void)joinChatRoom:(NSString *)targetId messageCount:(int)messageCount success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`targetId`	聊天室 ID
`messageCount`	进入聊天室时获取历史消息的数量，-1 <= messageCount <= 50
`successBlock`	加入聊天室成功的回调
`errorBlock`	加入聊天室失败的回调 [status: 加入聊天室失败的错误码] @discussion 可以通过传入的 messageCount 设置加入聊天室成功之后需要获取的历史消息数量。 -1 表示不获取任何历史消息，0 表示不特殊设置而使用SDK默认的设置（默认为获取 10 条），0 < messageCount <= 50 为具体获取的消息数量,最大值为 50。注：如果是 7.x 系统获取历史消息数量不要大于 30 @remarks 聊天室

Discussion

加入聊天室（如果聊天室不存在则会创建）

Declared In

RCIMClient.h

`– joinExistChatRoom:messageCount:success:error:`

加入已经存在的聊天室（如果聊天室不存在返回错误 23410，人数超限返回错误 23411）

- (void)joinExistChatRoom:(NSString *)targetId messageCount:(int)messageCount success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`targetId`	聊天室 ID
`messageCount`	进入聊天室时获取历史消息的数量，-1 <= messageCount <= 50
`successBlock`	加入聊天室成功的回调
`errorBlock`	加入聊天室失败的回调 [status: 加入聊天室失败的错误码] @warning 注意：使用 IMKit 库的会话页面，viewDidLoad 会自动调用 joinChatRoom 加入聊天室（聊天室不存在会自动创建）。如果您只想加入已存在的聊天室，需要在 push 到会话页面之前调用这个方法并且 messageCount 传 -1，成功之后 push 到会话页面，失败需要您做相应提示处理。 @discussion 可以通过传入的 messageCount 设置加入聊天室成功之后，需要获取的历史消息数量。 -1 表示不获取任何历史消息，0 表示不特殊设置而使用SDK默认的设置（默认为获取 10 条），0 < messageCount <= 50 为具体获取的消息数量，最大值为 50。 @remarks 聊天室

Discussion

加入已经存在的聊天室（如果聊天室不存在返回错误 23410，人数超限返回错误 23411）

Declared In

RCIMClient.h

`– quitChatRoom:success:error:`

退出聊天室

- (void)quitChatRoom:(NSString *)targetId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

targetId

聊天室 ID

successBlock

退出聊天室成功的回调

errorBlock

退出聊天室失败的回调 [status:退出聊天室失败的错误码]

@remarks 聊天室

Discussion

退出聊天室

Declared In

RCIMClient.h

`– getChatRoomInfo:count:order:success:error:`

获取聊天室的信息（包含部分成员信息和当前聊天室中的成员总数）

- (void)getChatRoomInfo:(NSString *)targetId count:(int)count order:(RCChatRoomMemberOrder)order success:(void ( ^ ) ( RCChatRoomInfo *chatRoomInfo ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`targetId`	聊天室 ID
`count`	需要获取的成员信息的数量（目前获取到的聊天室信息中仅包含不多于 20 人的成员信息，即 0 <= count <= 20，传入 0 获取到的聊天室信息将或仅包含成员总数，不包含具体的成员列表）
`order`	需要获取的成员列表的顺序（最早加入或是最晚加入的部分成员）
`successBlock`	获取成功的回调 [chatRoomInfo:聊天室信息]
`errorBlock`	获取失败的回调 [status:获取失败的错误码] @discussion 因为聊天室一般成员数量巨大，权衡效率和用户体验，目前返回的聊天室信息仅包含不多于 20 人的成员信息和当前成员总数。如果您使用 RC_ChatRoom_Member_Asc 升序方式查询，将返回最早加入的成员信息列表，按加入时间从旧到新排列；如果您使用 RC_ChatRoom_Member_Desc 降序方式查询，将返回最晚加入的成员信息列表，按加入时间从新到旧排列。 @remarks 聊天室

Discussion

获取聊天室的信息（包含部分成员信息和当前聊天室中的成员总数）

Declared In

RCIMClient.h

`– setChatRoomStatusDelegate:`

设置 IMLib 的聊天室状态监听器

- (void)setChatRoomStatusDelegate:(id<RCChatRoomStatusDelegate>)delegate

Parameters

delegate

IMLib 聊天室状态监听器

@remarks 聊天室

Discussion

设置 IMLib 的聊天室状态监听器

Declared In

RCIMClient.h

`– searchPublicService:searchKey:success:error:`

查找公众服务账号

- (void)searchPublicService:(RCSearchType)searchType searchKey:(NSString *)searchKey success:(void ( ^ ) ( NSArray *accounts ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`searchType`	查找匹配方式
`searchKey`	查找关键字
`successBlock`	查找成功的回调 [accounts:查找到的公众服务账号信息 RCPublicServiceProfile 的数组]
`errorBlock`	查找失败的回调 [status:失败的错误码] @remarks 公众号

Discussion

查找公众服务账号

Declared In

RCIMClient.h

`– searchPublicServiceByType:searchType:searchKey:success:error:`

按类型查找公众服务账号

- (void)searchPublicServiceByType:(RCPublicServiceType)publicServiceType searchType:(RCSearchType)searchType searchKey:(NSString *)searchKey success:(void ( ^ ) ( NSArray *accounts ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`publicServiceType`	公众服务账号的类型
`searchType`	查找匹配方式
`searchKey`	查找关键字
`successBlock`	查找成功的回调 [accounts:查找到的公众服务账号信息 RCPublicServiceProfile 的数组]
`errorBlock`	查找失败的回调 [status:失败的错误码] @remarks 公众号

Discussion

按类型查找公众服务账号

Declared In

RCIMClient.h

`– subscribePublicService:publicServiceId:success:error:`

关注公众服务账号

- (void)subscribePublicService:(RCPublicServiceType)publicServiceType publicServiceId:(NSString *)publicServiceId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`publicServiceType`	公众服务账号的类型
`publicServiceId`	公众服务的账号 ID
`successBlock`	关注成功的回调
`errorBlock`	关注失败的回调 [status:失败的错误码] @remarks 公众号

Discussion

关注公众服务账号

Declared In

RCIMClient.h

`– unsubscribePublicService:publicServiceId:success:error:`

取消关注公众服务账号

- (void)unsubscribePublicService:(RCPublicServiceType)publicServiceType publicServiceId:(NSString *)publicServiceId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`publicServiceType`	公众服务账号的类型
`publicServiceId`	公众服务的账号 ID
`successBlock`	取消关注成功的回调
`errorBlock`	取消关注失败的回调 [status:失败的错误码] @remarks 公众号

Discussion

取消关注公众服务账号

Declared In

RCIMClient.h

`– getPublicServiceList`

查询已关注的公众服务账号

- (NSArray *)getPublicServiceList

Return Value

公众服务信息 RCPublicServiceProfile 列表

@remarks 公众号

Discussion

查询已关注的公众服务账号

Declared In

RCIMClient.h

`– getPublicServiceProfile:publicServiceId:`

获取公众服务账号信息

- (RCPublicServiceProfile *)getPublicServiceProfile:(RCPublicServiceType)publicServiceType publicServiceId:(NSString *)publicServiceId

Parameters

`publicServiceType`	公众服务账号的类型
`publicServiceId`	公众服务的账号 ID

Return Value

公众服务账号的信息

Discussion

获取公众服务账号信息

此方法会从本地缓存中获取公众服务账号信息

@remarks 公众号

Declared In

RCIMClient.h

`– getPublicServiceProfile:conversationType:onSuccess:onError:`

获取公众服务账号信息

- (void)getPublicServiceProfile:(NSString *)targetId conversationType:(RCConversationType)type onSuccess:(void ( ^ ) ( RCPublicServiceProfile *serviceProfile ))onSuccess onError:(void ( ^ ) ( RCErrorCode errorCode ))onError

Parameters

`targetId`	公众服务的账号 ID
`type`	公众服务账号的类型
`onSuccess`	获取成功的回调 [serviceProfile:获取到的公众账号信息]
`onError`	获取失败的回调 [error:失败的错误码]

Discussion

获取公众服务账号信息

此方法会从服务器获取公众服务账号信息

@remarks 公众号

Declared In

RCIMClient.h

`– getPublicServiceWebViewController:`

获取公众服务使用的 WebView Controller

- (UIViewController *)getPublicServiceWebViewController:(NSString *)URLString

Parameters

`URLString`	准备打开的 URL

Return Value

公众服务使用的 WebView Controller

@discussion 如果您选在用 WebView 打开 URL 连接，则您需要在 App 的 Info.plist 的 NSAppTransportSecurity 中增加 NSAllowsArbitraryLoadsInWebContent 和 NSAllowsArbitraryLoads 字段，并在苹果审核的时候提供额外的说明。更多内容可以参考：https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW55

@remarks 公众号

Discussion

获取公众服务使用的 WebView Controller

Declared In

RCIMClient.h

`– recordLaunchOptionsEvent:`

统计App启动的事件

- (void)recordLaunchOptionsEvent:(NSDictionary *)launchOptions

Parameters

`launchOptions`	App的启动附加信息

Discussion

统计App启动的事件

此方法用于统计融云推送服务的点击率。如果您需要统计推送服务的点击率，只需要在 AppDelegate 的-application:didFinishLaunchingWithOptions:中，调用此方法并将 launchOptions 传入即可。

@remarks 高级功能

Declared In

RCIMClient.h

`– recordLocalNotificationEvent:`

统计本地通知的事件

- (void)recordLocalNotificationEvent:(UILocalNotification *)notification

Parameters

`notification`	本体通知的内容

Discussion

统计本地通知的事件

此方法用于统计融云推送服务的点击率。如果您需要统计推送服务的点击率，只需要在AppDelegate 的-application:didReceiveLocalNotification:中，调用此方法并将 launchOptions 传入即可。

@remarks 高级功能

Declared In

RCIMClient.h

`– recordRemoteNotificationEvent:`

统计远程推送的事件

- (void)recordRemoteNotificationEvent:(NSDictionary *)userInfo

Parameters

`userInfo`	远程推送的内容

Discussion

统计远程推送的事件

此方法用于统计融云推送服务的点击率。如果您需要统计推送服务的点击率，只需要在 AppDelegate 的-application:didReceiveRemoteNotification:中，调用此方法并将 launchOptions 传入即可。

@remarks 高级功能

Declared In

RCIMClient.h

`– getPushExtraFromLaunchOptions:`

获取点击的启动事件中，融云推送服务的扩展字段

- (NSDictionary *)getPushExtraFromLaunchOptions:(NSDictionary *)launchOptions

Parameters

`launchOptions`	App 的启动附加信息

Return Value

收到的融云推送服务的扩展字段，nil 表示该启动事件不包含来自融云的推送服务

Discussion

获取点击的启动事件中，融云推送服务的扩展字段

此方法仅用于获取融云推送服务的扩展字段。

@remarks 高级功能

Declared In

RCIMClient.h

`– getPushExtraFromRemoteNotification:`

获取点击的远程推送中，融云推送服务的扩展字段

- (NSDictionary *)getPushExtraFromRemoteNotification:(NSDictionary *)userInfo

Parameters

`userInfo`	远程推送的内容

Return Value

收到的融云推送服务的扩展字段，nil 表示该远程推送不包含来自融云的推送服务

Discussion

获取点击的远程推送中，融云推送服务的扩展字段

此方法仅用于获取融云推送服务的扩展字段。

@remarks 高级功能

Declared In

RCIMClient.h

`+ getVersion`

获取当前 IMLib SDK的版本号

+ (NSString *)getVersion

Return Value

当前 IMLib SDK 的版本号，如: @“2.0.0”

@remarks 数据获取

Discussion

获取当前 IMLib SDK的版本号

Declared In

RCIMClient.h

`– getDeltaTime`

获取当前手机与服务器的时间差

- (long long)getDeltaTime

Return Value

时间差

Discussion

获取当前手机与服务器的时间差

消息发送成功后，SDK 会与服务器同步时间，消息所在数据库中存储的时间就是服务器时间。

@remarks 数据获取

Declared In

RCIMClient.h

`– decodeAMRToWAVE:`

将AMR格式的音频数据转化为 WAV 格式的音频数据，数据开头携带 WAVE 文件头

- (NSData *)decodeAMRToWAVE:(NSData *)data

Parameters

`data`	AMR 格式的音频数据，必须是 AMR-NB 的格式

Return Value

WAV 格式的音频数据

@remarks 数据获取

Discussion

将AMR格式的音频数据转化为 WAV 格式的音频数据，数据开头携带 WAVE 文件头

Declared In

RCIMClient.h

`– decodeAMRToWAVEWithoutHeader:`

将 AMR 格式的音频数据转化为 WAV 格式的音频数据，数据开头不携带 WAV 文件头

- (NSData *)decodeAMRToWAVEWithoutHeader:(NSData *)data

Parameters

`data`	AMR 格式的音频数据，必须是 AMR-NB 的格式

Return Value

WAV 格式的音频数据

@remarks 数据获取

Discussion

将 AMR 格式的音频数据转化为 WAV 格式的音频数据，数据开头不携带 WAV 文件头

Declared In

RCIMClient.h

`)`

语音消息采样率，默认 8KHz

@property (nonatomic, assign) RCSampleRate sampleRate __deprecated_msg ( "已废弃，请勿使用。" )

Discussion

语音消息采样率，默认 8KHz

@discussion 2.9.12 之前的版本只支持 8KHz。如果设置为 16KHz，老版本将无法播放 16KHz 的语音消息。客服会话只支持 8KHz。

@remarks 功能设置

Declared In

RCIMClient.h

`voiceMsgType`

语音消息类型，默认 RCVoiceMessageTypeOrdinary

@property (nonatomic, assign) RCVoiceMessageType voiceMsgType

Discussion

语音消息类型，默认 RCVoiceMessageTypeOrdinary

老版本 SDK 不兼容新版本语音消息 2.9.19 之前的版本无法播放高音质语音消息； 2.9.19 及之后的版本可以同时兼容普通音质语音消息和高音质语音消息；客服会话类型 (ConversationType_CUSTOMERSERVICE) 不支持高音质语音消息。

@remarks 功能设置

Declared In

RCIMClient.h

`– startCustomerService:info:onSuccess:onError:onModeType:onPullEvaluation:onSelectGroup:onQuit:`

发起客服聊天

- (void)startCustomerService:(NSString *)kefuId info:(RCCustomerServiceInfo *)csInfo onSuccess:(void ( ^ ) ( RCCustomerServiceConfig *config ))successBlock onError:(void ( ^ ) ( int errorCode , NSString *errMsg ))errorBlock onModeType:(void ( ^ ) ( RCCSModeType mode ))modeTypeBlock onPullEvaluation:(void ( ^ ) ( NSString *dialogId ))pullEvaluationBlock onSelectGroup:(void ( ^ ) ( NSArray<RCCustomerServiceGroupItem*> *groupList ))selectGroupBlock onQuit:(void ( ^ ) ( NSString *quitMsg ))quitBlock

Parameters

`kefuId`	客服 ID
`csInfo`	客服信息
`successBlock`	发起客服会话成功的回调
`errorBlock`	发起客服会话失败的回调 [errorCode:失败的错误码 errMsg:错误信息]
`modeTypeBlock`	客服模式变化
`pullEvaluationBlock`	客服请求评价
`selectGroupBlock`	客服分组选择
`quitBlock`	客服被动结束。如果主动调用 stopCustomerService，则不会调用到该 block @discussion 有些客服提供商可能会主动邀请评价，有些不会，所以用lib开发客服需要注意对 pullEvaluationBlock 的处理。在 pullEvaluationBlock 里应该弹出评价。如果 pullEvaluationBlock 没有被调用到，需要在结束客服时（之前之后都可以）弹出评价框并评价。如果客服有分组，selectGroupBlock 会被回调，此时必须让用户选择分组然后调用 selectCustomerServiceGroup:withGroupId:。

Discussion

发起客服聊天

Warning: 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– getHumanEvaluateCustomerServiceConfig:`

客服后台关于评价相关的客服参数配置

- (void)getHumanEvaluateCustomerServiceConfig:(void ( ^ ) ( NSDictionary *evaConfig ))evaConfigBlock

Parameters

`evaConfigBlock`	客服配置回调

Discussion

客服后台关于评价相关的客服参数配置

此方法依赖 startCustomerService 方法，只有调用成功以后才有效。

Warning: 如果你使用的 IMLib，或者使用kit但想要自定义评价弹窗，可以参考相关配置绘制评价 UI

@remarks 客服

Declared In

RCIMClient.h

`– stopCustomerService:`

结束客服聊天

- (void)stopCustomerService:(NSString *)kefuId

Parameters

`kefuId`	客服 ID

Discussion

结束客服聊天

此方法依赖 startCustomerService 方法，只有调用成功以后才有效。 @warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– selectCustomerServiceGroup:withGroupId:`

选择客服分组模式

- (void)selectCustomerServiceGroup:(NSString *)kefuId withGroupId:(NSString *)groupId

Parameters

`kefuId`	客服 ID
`groupId`	选择的客服分组 id

Discussion

选择客服分组模式

此方法依赖 startCustomerService 方法，只有调用成功以后才有效。 @warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– switchToHumanMode:`

切换客服模式

- (void)switchToHumanMode:(NSString *)kefuId

Parameters

kefuId

客服 ID

@discussion 此方法依赖 startCustomerService 方法，而且只有当前客服模式为机器人优先才可调用。 @warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Discussion

切换客服模式

Declared In

RCIMClient.h

`– evaluateCustomerService:knownledgeId:robotValue:suggest:`

评价机器人客服，用于对单条机器人应答的评价。

- (void)evaluateCustomerService:(NSString *)kefuId knownledgeId:(NSString *)knownledgeId robotValue:(BOOL)isRobotResolved suggest:(NSString *)suggest

Parameters

`kefuId`	客服 ID
`knownledgeId`	知识点 ID
`isRobotResolved`	是否解决问题
`suggest`	客户建议

Discussion

评价机器人客服，用于对单条机器人应答的评价。

此方法依赖 startCustomerService 方法。可在客服结束之前或之后调用。 @discussion 有些客服服务商需要对机器人回答的词条进行评价，机器人回答的文本消息的 extra 带有{“robotEva”:”1”, “sid”:”xxx”}字段，当用户对这一条消息评价后调用本函数同步到服务器，knownledgedID为extra 中的 sid。若是离开会话触发的评价或者在加号扩展中主动触发的评价，knownledgedID 填 nil

@warning 如果你使用IMKit，请不要使用此方法。RCConversationViewController默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– evaluateCustomerService:dialogId:starValue:suggest:resolveStatus:tagText:extra:`

评价人工客服。

- (void)evaluateCustomerService:(NSString *)kefuId dialogId:(NSString *)dialogId starValue:(int)value suggest:(NSString *)suggest resolveStatus:(RCCSResolveStatus)resolveStatus tagText:(NSString *)tagText extra:(NSDictionary *)extra

Parameters

`kefuId`	客服 ID
`dialogId`	对话 ID，客服请求评价的对话 ID
`value`	分数，取值范围 1-5
`suggest`	客户建议
`resolveStatus`	解决状态，如果没有解决状态，这里可以随意赋值，SDK 不会处理
`tagText`	客户评价的标签
`extra`	扩展内容

Discussion

评价人工客服。

此方法依赖 startCustomerService 方法。可在客服结束之前或之后调用。 @discussion 有些客服服务商会主动邀请评价，pullEvaluationBlock 会被调用到，当评价完成后调用本函数同步到服务器，dialogId 填 pullEvaluationBlock 返回的 dialogId。若是离开会话触发的评价或者在加号扩展中主动触发的评价，dialogID 为 nil

@warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– evaluateCustomerService:dialogId:starValue:suggest:resolveStatus:`

通用客服评价，不区分机器人人工

- (void)evaluateCustomerService:(NSString *)kefuId dialogId:(NSString *)dialogId starValue:(int)value suggest:(NSString *)suggest resolveStatus:(RCCSResolveStatus)resolveStatus

Parameters

`kefuId`	客服 ID
`dialogId`	对话 ID，客服请求评价的对话 ID
`value`	分数，取值范围 1-5
`suggest`	客户建议
`resolveStatus`	解决状态，如果没有解决状态，这里可以随意赋值，SDK不会处理

Discussion

通用客服评价，不区分机器人人工

此方法依赖 startCustomerService 方法。可在客服结束之前或之后调用。 @discussion 有些客服服务商会主动邀请评价，pullEvaluationBlock 会被调用到，当评价完成后调用本函数同步到服务器，dialogId 填 pullEvaluationBlock 返回的 dialogId。若是离开会话触发的评价或者在加号扩展中主动触发的评价，dialogID 为 nil @warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– leaveMessageCustomerService:leaveMessageDic:success:failure:`

客服留言

- (void)leaveMessageCustomerService:(NSString *)kefuId leaveMessageDic:(NSDictionary *)leaveMessageDic success:(void ( ^ ) ( void ))successBlock failure:(void ( ^ ) ( void ))failureBlock

Parameters

`kefuId`	客服 ID
`leaveMessageDic`	客服留言信息字典，根据 RCCSLeaveMessageItem 中关于留言的配置存储对应的 key-value
`successBlock`	成功回调
`failureBlock`	失败回调

Discussion

客服留言

此方法依赖 startCustomerService 方法。可在客服结束之前或之后调用。

如果一些值没有，可以传 nil @warning 如果你使用 IMKit，请不要使用此方法。RCConversationViewController 默认已经做了处理。

@remarks 客服

Declared In

RCIMClient.h

`– searchMessages:targetId:keyword:count:startTime:`

根据关键字搜索指定会话中的消息

- (NSArray<RCMessage*> *)searchMessages:(RCConversationType)conversationType targetId:(NSString *)targetId keyword:(NSString *)keyword count:(int)count startTime:(long long)startTime

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`keyword`	关键字
`count`	最大的查询数量
`startTime`	查询 startTime 之前的消息（传 0 表示不限时间）

Return Value

匹配的消息列表

@remarks 消息操作

Discussion

根据关键字搜索指定会话中的消息

Declared In

RCIMClient.h

`– searchMessages:targetId:userId:count:startTime:`

按用户 ID 搜索指定会话中的消息

- (NSArray<RCMessage*> *)searchMessages:(RCConversationType)conversationType targetId:(NSString *)targetId userId:(NSString *)userId count:(int)count startTime:(long long)startTime

Parameters

`conversationType`	会话类型
`targetId`	会话 ID
`userId`	搜索用户 ID
`count`	最大的查询数量
`startTime`	查询 startTime 之前的消息（传 0 表示不限时间）

Return Value

匹配的消息列表

@remarks 消息操作

Discussion

按用户 ID 搜索指定会话中的消息

Declared In

RCIMClient.h

`– searchConversations:messageType:keyword:`

根据关键字搜索会话

- (NSArray<RCSearchConversationResult*> *)searchConversations:(NSArray<NSNumber*> *)conversationTypeList messageType:(NSArray<NSString*> *)objectNameList keyword:(NSString *)keyword

Parameters

`conversationTypeList`	需要搜索的会话类型列表
`objectNameList`	需要搜索的消息类型名列表(即每个消息类方法 getObjectName 的返回值)
`keyword`	关键字

Return Value

匹配的会话搜索结果列表

Discussion

根据关键字搜索会话

目前，SDK 内置的文本消息、文件消息、图文消息支持搜索。自定义的消息必须要实现 RCMessageContent 的 getSearchableWords 接口才能进行搜索。

@remarks 消息操作

Declared In

RCIMClient.h

`logLevel`

设置日志级别

@property (nonatomic, assign) RCLogLevel logLevel

Discussion

设置日志级别

@remarks 高级功能

Declared In

RCIMClient.h

`– setRCLogInfoDelegate:`

设置 IMLib 日志的监听器

- (void)setRCLogInfoDelegate:(id<RCLogInfoDelegate>)delegate

Parameters

`delegate`	IMLib 日志的监听器

Discussion

设置 IMLib 日志的监听器

您可以通过 logLevel 来控制日志的级别。

@remarks 功能设置

Declared In

RCIMClient.h

`fileStoragePath`

文件消息下载路径

@property (nonatomic, strong, readonly) NSString *fileStoragePath

Discussion

文件消息下载路径

默认值为沙盒下的 Documents/MyFile 目录。您可以通过修改 RCConfig.plist 中的 RelativePath 来修改该路径。

@remarks 数据获取

Declared In

RCIMClient.h

`– getVendorToken:error:`

获取Vendor token. 仅供融云第三方服务厂家使用。

- (void)getVendorToken:(void ( ^ ) ( NSString *vendorToken ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

successBlock

成功回调

errorBlock

失败回调

@remarks 数据获取

Discussion

获取Vendor token. 仅供融云第三方服务厂家使用。

Declared In

RCIMClient.h

`pushProfile`

远程推送相关设置

@property (nonatomic, strong, readonly) RCPushProfile *pushProfile

Discussion

远程推送相关设置

@remarks 功能设置

Declared In

RCIMClient.h

`– setOfflineMessageDuration:success:failure:`

设置离线消息在服务端的存储时间（以天为单位）

- (void)setOfflineMessageDuration:(int)duration success:(void ( ^ ) ( void ))successBlock failure:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

duration

存储时间，范围【1~7天】

successBlock

成功回调

errorBlock

失败回调

@remarks 功能设置

Discussion

设置离线消息在服务端的存储时间（以天为单位）

Declared In

RCIMClient.h

`– getOfflineMessageDuration`

获取离线消息时间（以天为单位）

- (int)getOfflineMessageDuration

Return Value

离线消息存储时间

@remarks 数据获取

Discussion

获取离线消息时间（以天为单位）

Declared In

RCIMClient.h

`– setAppVer:`

设置集成 SDK 的用户 App 版本信息。便于融云排查问题时，作为分析依据，属于自愿行为。

- (void)setAppVer:(NSString *)appVer

Parameters

appVer

用户 APP 的版本信息。

@remarks 功能设置

Discussion

设置集成 SDK 的用户 App 版本信息。便于融云排查问题时，作为分析依据，属于自愿行为。

Declared In

RCIMClient.h

`– getGIFLimitSize`

GIF 消息大小限制，以 KB 为单位，超过这个大小的 GIF 消息不能被发送

- (NSInteger)getGIFLimitSize

Return Value

GIF 消息大小，以 KB 为单位

@remarks 数据获取

Discussion

GIF 消息大小限制，以 KB 为单位，超过这个大小的 GIF 消息不能被发送

Declared In

RCIMClient.h

`– setRCChatRoomKVStatusChangeDelegate:`

设置聊天室 KV 状态变化监听器

- (void)setRCChatRoomKVStatusChangeDelegate:(id<RCChatRoomKVStatusChangeDelegate>)delegate

Parameters

`delegate`	聊天室 KV 状态变化的监听器

Discussion

设置聊天室 KV 状态变化监听器

可以设置并实现此 delegate 来进行聊天室状态变化的监听。SDK 会在回调中通知您聊天室状态的改变。

@remarks 功能设置

Declared In

RCIMClient.h

`– setChatRoomEntry:key:value:sendNotification:autoDelete:notificationExtra:success:error:`

设置聊天室自定义属性

- (void)setChatRoomEntry:(NSString *)chatroomId key:(NSString *)key value:(NSString *)value sendNotification:(BOOL)sendNotification autoDelete:(BOOL)autoDelete notificationExtra:(NSString *)notificationExtra success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`key`	聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
`value`	聊天室属性对应的值，最大长度 4096 个字符
`sendNotification`	是否需要发送通知，如果发送通知，聊天室中的其他用户会接收到 RCChatroomKVNotificationMessage 通知消息，消息内容中包含操作类型(type)、属性名称(key)、属性名称对应的值(value)和自定义字段(extra)
`autoDelete`	用户掉线或退出时，是否自动删除该 Key、Value 值；自动删除时不会发送通知
`notificationExtra`	通知的自定义字段，RC:chrmKVNotiMsg 通知消息中会包含此字段，最大长度 2 kb
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

设置聊天室自定义属性

必须先开通聊天室状态存储功能设置聊天室自定义属性，当 key 不存在时，代表增加属性；当 key 已经存在时，代表更新属性的值，且只有 key 的创建者可以更新属性的值。

@remarks 聊天室

Declared In

RCIMClient.h

`– forceSetChatRoomEntry:key:value:sendNotification:autoDelete:notificationExtra:success:error:`

强制设置聊天室自定义属性

- (void)forceSetChatRoomEntry:(NSString *)chatroomId key:(NSString *)key value:(NSString *)value sendNotification:(BOOL)sendNotification autoDelete:(BOOL)autoDelete notificationExtra:(NSString *)notificationExtra success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`key`	聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
`value`	聊天室属性对应的值，最大长度 4096 个字符
`sendNotification`	是否需要发送通知，如果发送通知，聊天室中的其他用户会接收到 RCChatroomKVNotificationMessage 通知消息，消息内容中包含操作类型(type)、属性名称(key)、属性名称对应的值(value)和自定义字段(extra)
`autoDelete`	用户掉线或退出时，是否自动删除该 Key、Value 值；自动删除时不会发送通知
`notificationExtra`	通知的自定义字段，RCChatroomKVNotificationMessage 通知消息中会包含此字段，最大长度 2 kb
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

强制设置聊天室自定义属性

必须先开通聊天室状态存储功能强制设置聊天室自定义属性，当 key 不存在时，代表增加属性；当 key 已经存在时，代表更新属性的值。

@remarks 聊天室

Declared In

RCIMClient.h

`– getChatRoomEntry:key:success:error:`

获取聊天室单个属性

- (void)getChatRoomEntry:(NSString *)chatroomId key:(NSString *)key success:(void ( ^ ) ( NSDictionary *entry ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`key`	聊天室属性名称
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

获取聊天室单个属性

必须先开通聊天室状态存储功能

@remarks 聊天室

Declared In

RCIMClient.h

`– getAllChatRoomEntries:success:error:`

获取聊天室所有自定义属性

- (void)getAllChatRoomEntries:(NSString *)chatroomId success:(void ( ^ ) ( NSDictionary *entry ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

获取聊天室所有自定义属性

必须先开通聊天室状态存储功能

@remarks 聊天室

Declared In

RCIMClient.h

`– removeChatRoomEntry:key:sendNotification:notificationExtra:success:error:`

删除聊天室自定义属性

- (void)removeChatRoomEntry:(NSString *)chatroomId key:(NSString *)key sendNotification:(BOOL)sendNotification notificationExtra:(NSString *)notificationExtra success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`key`	聊天室属性名称
`sendNotification`	是否需要发送通知，如果发送通知，聊天室中的其他用户会接收到 RCChatroomKVNotificationMessage 通知消息，消息内容中包含操作类型(type)、属性名称(key)、属性名称对应的值(value)和自定义字段(extra)
`notificationExtra`	通知的自定义字段，RCChatroomKVNotificationMessage 通知消息中会包含此字段，最大长度 2 kb
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

删除聊天室自定义属性

必须先开通聊天室状态存储功能删除聊天室自定义属性，只有自己设置的属性可以被删除。

@remarks 聊天室

Declared In

RCIMClient.h

`– forceRemoveChatRoomEntry:key:sendNotification:notificationExtra:success:error:`

强制删除聊天室自定义属性

- (void)forceRemoveChatRoomEntry:(NSString *)chatroomId key:(NSString *)key sendNotification:(BOOL)sendNotification notificationExtra:(NSString *)notificationExtra success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode nErrorCode ))errorBlock

Parameters

`chatroomId`	聊天室 ID
`key`	聊天室属性名称
`sendNotification`	是否需要发送通知，如果发送通知，聊天室中的其他用户会接收到 RCChatroomKVNotificationMessage 通知消息，消息内容中包含操作类型(type)、属性名称(key)、属性名称对应的值(value)和自定义字段(extra)
`notificationExtra`	通知的自定义字段，RCChatroomKVNotificationMessage 通知消息中会包含此字段，最大长度 2 kb
`successBlock`	成功回调
`errorBlock`	失败回调

Discussion

强制删除聊天室自定义属性

必须先开通聊天室状态存储功能强制删除聊天室自定义属性。

@remarks 聊天室

Declared In

RCIMClient.h

`– setRCConversationStatusChangeDelegate:`

设置会话状态（包含置顶，消息免打扰）同步的监听器

- (void)setRCConversationStatusChangeDelegate:(id<RCConversationStatusChangeDelegate>)delegate

Parameters

`delegate`	会话状态同步的监听器

Discussion

设置会话状态（包含置顶，消息免打扰）同步的监听器

可以设置并实现此 delegate 来进行会话状态同步。SDK 会在回调的 conversationStatusChange:方法中通知您会话状态的改变。

@remarks 功能设置

Declared In

RCIMClient.h

`– updateMessageExpansion:messageUId:success:error:`

更新消息扩展信息

- (void)updateMessageExpansion:(NSDictionary<NSString*,NSString*> *)expansionDic messageUId:(NSString *)messageUId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`expansionDic`	要更新的消息扩展信息键值对
`messageUId`	消息 messageUId
`successBlock`	成功的回调
`errorBlock`	失败的回调

Discussion

更新消息扩展信息

消息扩展信息是以字典形式存在。设置的时候从 expansionDic 中读取 key，如果原有的扩展信息中 key 不存在则添加新的 KV 对，如果 key 存在则替换成新的 value。

扩展信息只支持单聊和群组，其它会话类型不能设置扩展信息

扩展信息字典中的 Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 32；Value 最长长度，单次设置扩展数量最大为 20，消息的扩展总数不能超过 300

@remarks 高级功能

Declared In

RCIMClient.h

`– removeMessageExpansionForKey:messageUId:success:error:`

删除消息扩展信息中特定的键值对

- (void)removeMessageExpansionForKey:(NSArray<NSString*> *)keyArray messageUId:(NSString *)messageUId success:(void ( ^ ) ( void ))successBlock error:(void ( ^ ) ( RCErrorCode status ))errorBlock

Parameters

`keyArray`	消息扩展信息中待删除的 key 的列表
`messageUId`	消息 messageUId
`successBlock`	成功的回调
`errorBlock`	失败的回调

Discussion

删除消息扩展信息中特定的键值对

扩展信息只支持单聊和群组，其它会话类型不能设置扩展信息

@remarks 高级功能

Declared In

RCIMClient.h

`messageExpansionDelegate`

设置 IMlib 的消息扩展监听器

@property (nonatomic, weak) id<RCMessageExpansionDelegate> messageExpansionDelegate

Discussion

设置 IMlib 的消息扩展监听器

代理回调在非主线程

@remarks 高级功能

Declared In

RCIMClient.h

`imageCompressConfig`

缩略图压缩配置

@property (nonatomic, strong) RCImageCompressConfig *imageCompressConfig

Discussion

缩略图压缩配置

@remarks 缩略图压缩配置，如果此处设置了配置就按照这个配置进行压缩。如果此处没有设置，会按照 RCConfig.plist 中的配置进行压缩。

Declared In

RCIMClient.h

RCIMClient Class Reference

Overview

Return Value

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Return Value

Discussion

Declared In

Return Value

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters

Return Value

Discussion

Declared In

Parameters