Options
All
  • Public
  • Public/Protected
  • All
Menu

System notification definition

Hierarchy

  • NIMSystemMessage

Index

Properties

apnsText?: string

The content of a push notification for the custom system notification, valid only for iOS devices.

attach?: { custom?: string }

Additional information of built-in system notifications. You can view additional information for different types of system notifications

Type declaration

  • Optional custom?: string

    the extension field of additional messages

category?: string

Type of a built-in system notification

cc?: boolean

Whether messaging webhook is required for custom system notifications. The default value is true

content?: string

Content of a custom system notification Note that the content must be a string that can be parsed in JSON

When the state of the built-in system notification is 'error', this field contains error information

from: string

Source of system notification, account or group ID

idServer?: string

idServer of a built-in system notification

isPushable?: boolean

Whether a push notification is required

localCustom?: string

Custom extension fields for built-in system notifications stored in the local database.

Note: This field only exists when the database is running.

needPushNick?: boolean

Whether a push notification is required with the nickname

ps?: string

Additional message of a system notification

pushPayload?: string

Payload of a push notification for the custom system notification

Note that the payload must be in JSON string

read?: boolean

Whether the built-in system notification is read

scene?: string

scenario for custom system notifications, refer to messaging scenario

sendToOnlineUsersOnly?: boolean

Whether to deliver custom system notifications only to online users

true: only sent to online users, suitable for sending instant notifications, such as typing.

false: sent to offline users when they go online.

Note: This parameter is only valid for custom system notifications for private chats, and invalid for custom system notifications in group chats. Custom system notifications will only be sent to online group members and will not be stored for offline members.

state?: string

State of a built-in system notification

time: number

Timestamp

to: string

Target of a system notification, account or group ID

type: "custom" | "addFriend" | "applyFriend" | "passFriendApply" | "rejectFriendApply" | "deleteFriend" | "teamInvite" | "rejectTeamInvite" | "applyTeam" | "rejectTeamApply" | "applySuperTeam" | "rejectSuperTeamApply" | "superTeamInvite" | "rejectSuperTeamInvite" | "deleteMsg"

Type of a system notification