NIMMessageSetting Class Reference

Inherits from NSObject
Declared in NIMMessageSetting.h

Overview

Message settings

  historyEnabled

Specify whether the message is allowed to be retrieved in the message history

@property (nonatomic, assign) BOOL historyEnabled

Discussion

Specify whether the message is allowed to be retrieved in the message history

The default value is YES In most cases, all messages will appear in the result returned by the NIMConversationManager call (fetchMessageHistory:option:result:), but this value can be specified so that the message does not appear there.

Declared In

NIMMessageSetting.h

  roamingEnabled

Specify whether to support roaming

@property (nonatomic, assign) BOOL roamingEnabled

Discussion

Specify whether to support roaming

The default value is YES Message roaming allows messages sent within a certain period of time to be synchronized to the other devices to maximize message synchronization. For example, the messages sent and received on iOS devices will still be received after logging in to PC clients after one day. The messages are called roaming messages.

Declared In

NIMMessageSetting.h

  syncEnabled

Specify whether to support multiple device synchronization

@property (nonatomic, assign) BOOL syncEnabled

Discussion

Specify whether to support multiple device synchronization

The default value is YES By default, if the user logs in to an account on iOS devices and another account is logged in on another device such as PC at the same time, the messages sent on the iOS device will be synchronized to the other devices, and vise versa Note that since iOS applications are switched to background at times, messages sent by other terminals are synchronized through roaming messages after the iOS applicaion gets disconnected.

Declared In

NIMMessageSetting.h

  shouldBeCounted

Specify whether to count messages as unread

@property (nonatomic, assign) BOOL shouldBeCounted

Discussion

Specify whether to count messages as unread

The default value is YES By default, all messages a user receives are counted as unread. If the value is set to NO, the corresponding message will not be counted in the unread message count after the corresponding message is received by the peer.

Declared In

NIMMessageSetting.h

  apnsEnabled

Specify whether to enable push notification for the message

@property (nonatomic, assign) BOOL apnsEnabled

Discussion

Specify whether to enable push notification for the message

The default value is YES If the field is set to NO, messages are not delivered using APNs

Declared In

NIMMessageSetting.h

  apnsWithPrefix

Specify whether to add prefixes for messages. In most cases, a nickname is used as prefix.

@property (nonatomic, assign) BOOL apnsWithPrefix

Discussion

Specify whether to add prefixes for messages. In most cases, a nickname is used as prefix.

The default value is YES If the value is set to NO, push notifications will not have a prefix (xx:).

Declared In

NIMMessageSetting.h

  routeEnabled

Specify whether to enable State Sync

@property (nonatomic, assign) BOOL routeEnabled

Discussion

Specify whether to enable State Sync

The default value is YES. Messages will be synced to the developer’s server by default (if configured)

Declared In

NIMMessageSetting.h

  teamReceiptEnabled

Specify whether to send read receipts from other group members

@property (nonatomic, assign) BOOL teamReceiptEnabled

Discussion

Specify whether to send read receipts from other group members

The default value is NO by default, and all group receipt-related operations will take effect only after the value is set to YES

Declared In

NIMMessageSetting.h

  persistEnable

Option to support offline messages

@property (nonatomic, assign) BOOL persistEnable

Discussion

Option to support offline messages

The default value is YES. If the value is set to NO, the message will only be sent to the online users and dropped for offline users. This option is invalid for chat room messages

Declared In

NIMMessageSetting.h

  scene

The scene where the message are sent

@property (nonatomic, strong) NSString *scene

Discussion

The scene where the message are sent

Declared In

NIMMessageSetting.h

  isSessionUpdate

Option to update the session The default value is YES

@property (nonatomic, assign) BOOL isSessionUpdate

Discussion

Option to update the session The default value is YES

Declared In

NIMMessageSetting.h

  quickDeliveryEnabled

Specify whether to enable quick delivery for messages

@property (nonatomic, assign) BOOL quickDeliveryEnabled

Discussion

Specify whether to enable quick delivery for messages

The default value is NO If this field is set to YES, the message will be handled and sent with the highest priority within the SDK, but the operation will preempt the resources of other services. This option is only valid for peer-to-peer chats, group chats, and supergroup chats

Declared In

NIMMessageSetting.h