NIMMessageSetting Class Reference

Inherits from NSObject
Declared in NIMMessageSetting.h

Overview

消息配置

  historyEnabled

消息是否允许在消息历史中拉取(圈组支持)

@property (nonatomic, assign) BOOL historyEnabled

Discussion

消息是否允许在消息历史中拉取(圈组支持)

默认为YES。 正常而言所有消息都会出现在通过 NIMConversationManager 调用(fetchMessageHistory:option:result:)返回的结果中,但是可以通过设置这个值来使得消息不出现在这其中。

Declared In

NIMMessageSetting.h

  roamingEnabled

消息是否支持漫游

@property (nonatomic, assign) BOOL roamingEnabled

Discussion

消息是否支持漫游

默认为YES。 消息漫游的概念是指一定时间内发送的消息可以在另一端被同步到,以保证最大限度的消息同步。(如iOS上收发的消息过了一天登录PC仍旧会收到,这种消息我们称之为漫游消息)

Declared In

NIMMessageSetting.h

  syncEnabled

消息是否支持多端同步

@property (nonatomic, assign) BOOL syncEnabled

Discussion

消息是否支持多端同步

默认为YES。在默认情况下,如果用户在 iOS端和其他端(如PC)同时登录一个帐号,那么iOS 端发送的消息会被同步到其他端,同样其他端发送的消息也会被同步到 iOS 端。但是需要注意的是因为 iOS 经常会退到后台,所以其他端发送的消息在 iOS 断线后是通过漫游消息来同步到的。

Declared In

NIMMessageSetting.h

  shouldBeCounted

消息是否需要被计入未读计数(圈组支持)

@property (nonatomic, assign) BOOL shouldBeCounted

Discussion

消息是否需要被计入未读计数(圈组支持)

默认为YES。默认情况下,用户收到的所有消息都会被计入未读。设置这个为NO后,对应的消息被对端接受后将不计入未读消息计数内。

Declared In

NIMMessageSetting.h

  apnsEnabled

消息是否需要推送(圈组支持)

@property (nonatomic, assign) BOOL apnsEnabled

Discussion

消息是否需要推送(圈组支持)

默认为YES。将这个字段设为NO,消息将不再有苹果推送通知。

Declared In

NIMMessageSetting.h

  apnsWithPrefix

推送是否需要带前缀(一般为昵称,圈组支持)

@property (nonatomic, assign) BOOL apnsWithPrefix

Discussion

推送是否需要带前缀(一般为昵称,圈组支持)

默认为YES。将这个字段设为NO,推送消息将不带有前缀(xx:)。

Declared In

NIMMessageSetting.h

  routeEnabled

是否需要抄送

@property (nonatomic, assign) BOOL routeEnabled

Discussion

是否需要抄送

默认为YES,即默认会抄送消息给开发者的服务器(如果有配置的话)

Declared In

NIMMessageSetting.h

  teamReceiptEnabled

其他群成员收到此消息是否需要发送已读回执

@property (nonatomic, assign) BOOL teamReceiptEnabled

Discussion

其他群成员收到此消息是否需要发送已读回执

默认为NO,设置成 YES 之后所有群回执相关操作才会生效

Declared In

NIMMessageSetting.h

  persistEnable

消息是否支持离线

@property (nonatomic, assign) BOOL persistEnable

Discussion

消息是否支持离线

默认为YES,设置成 NO 之后消息将只会发送到在线的对端,对端不在线则会被丢弃。此开关对聊天室消息不生效

Declared In

NIMMessageSetting.h

  scene

消息对应的场景

@property (nonatomic, strong) NSString *scene

Discussion

消息对应的场景

Declared In

NIMMessageSetting.h

  isSessionUpdate

消息是否需要刷新到session服务。默认:是

@property (nonatomic, assign) BOOL isSessionUpdate

Discussion

消息是否需要刷新到session服务。默认:是

Declared In

NIMMessageSetting.h

  quickDeliveryEnabled

消息是否需要快速投递

@property (nonatomic, assign) BOOL quickDeliveryEnabled

Discussion

消息是否需要快速投递

默认为NO。将这个字段设为YES,消息在SDK内部将以最高优先级处理并发送,但会抢占其他业务的处理资源。此选项仅对点对点,群组,超大群会话类型有效

Declared In

NIMMessageSetting.h