NIMCustomSystemNotification Class Reference

Inherits from NSObject
Declared in NIMSystemNotification.h

Overview

Custom system notifications

  notificationId

Notification ID

@property (nonatomic, assign, readonly) int64_t notificationId

Discussion

Notification ID

Only received custom system notifications have notification IDs

Declared In

NIMSystemNotification.h

  timestamp

Timestamp

@property (nonatomic, assign, readonly) NSTimeInterval timestamp

Discussion

Timestamp

Declared In

NIMSystemNotification.h

  sender

Sender ID

@property (nullable, nonatomic, copy, readonly) NSString *sender

Discussion

Sender ID

Declared In

NIMSystemNotification.h

  receiver

Recipient ID

@property (nullable, nonatomic, copy, readonly) NSString *receiver

Discussion

Recipient ID

Declared In

NIMSystemNotification.h

  receiverType

Recipient types

@property (nonatomic, assign, readonly) NIMSessionType receiverType

Discussion

Recipient types

Declared In

NIMSystemNotification.h

  content

Message body in pass-through mode

@property (nullable, nonatomic, copy, readonly) NSString *content

Discussion

Message body in pass-through mode

Declared In

NIMSystemNotification.h

  sendToOnlineUsersOnly

Specify whether to deliver messages only to online users

@property (nonatomic, assign) BOOL sendToOnlineUsersOnly

Discussion

Specify whether to deliver messages only to online users

The default value is YES. If this value is set to NO, the recipient will receive the notification the next time the user logs in

Declared In

NIMSystemNotification.h

  apnsContent

APNs push notification content that can contain up to 500 characters

@property (nullable, nonatomic, copy) NSString *apnsContent

Discussion

APNs push notification content that can contain up to 500 characters

The default value is nil, users can specify the content of the current notification.

Declared In

NIMSystemNotification.h

  apnsPayload

APNS payload of a push notification

@property (nullable, nonatomic, copy) NSDictionary *apnsPayload

Discussion

APNS payload of a push notification

The field can contain a custom notification as payload. For more information about supported types, see @discussion the official Apple documentation on APNs. The can support a maximum of 2000 characters.

Declared In

NIMSystemNotification.h

  setting

Custom settings of system notifications

@property (nullable, nonatomic, strong) NIMCustomSystemNotificationSetting *setting

Discussion

Custom settings of system notifications

The field can be specified for settings, such as count as unread, and multi-device sync

Declared In

NIMSystemNotification.h

  antiSpamOption

Anti-spam option

@property (nullable, nonatomic, strong) NIMAntiSpamOption *antiSpamOption

Discussion

Anti-spam option

Declared In

NIMSystemNotification.h

  env

The environment variable used to point to different types of configurations for state sync and third-party callbacks.

@property (nullable, nonatomic, copy) NSString *env

Discussion

The environment variable used to point to different types of configurations for state sync and third-party callbacks.

Declared In

NIMSystemNotification.h

– initWithContent:

Initialization method of custom system notifications

- (instancetype)initWithContent:(NSString *)content

Parameters

content

custom content of a system notification

Return Value

custom system notifications instance

Discussion

Initialization method of custom system notifications

Declared In

NIMSystemNotification.h