react-native-notify-kit

react-native-notify-kit / AndroidPerson

Interface: AndroidPerson

Defined in: packages/react-native/src/types/NotificationAndroid.ts:763

The interface used to describe a person shown in notifications.

Currently used with AndroidMessagingStyle notifications.

Platform

android

Properties

bot?

optional bot: boolean

Defined in: packages/react-native/src/types/NotificationAndroid.ts:782

If true this person represents a machine rather than a human. This is used primarily for testing and automated tooling.

Defaults to false.

icon?

optional icon: string

Defined in: packages/react-native/src/types/NotificationAndroid.ts:801

The icon to display next to the person in the notification. The icon can be URL or local Android resource.

If not provided, an icon will be automatically creating using the name property.

id?

optional id: string

Defined in: packages/react-native/src/types/NotificationAndroid.ts:775

An optional unique ID of the person. Setting this property is preferred for unique identification, however not required. If no value is provided, the name will be used instead..

important?

optional important: boolean

Defined in: packages/react-native/src/types/NotificationAndroid.ts:793

If true this person will be marked as important.

Important users are those who frequently contact the receiving person. If the app is in "Do not disturb" mode, a notification containing an important person may override this mode if the person has been whitelisted on the device.

Defaults to false.

name

name: string

Defined in: packages/react-native/src/types/NotificationAndroid.ts:769

The name of the person.

If no id is provided, the name will be used as the unique identifier.

uri?

optional uri: string

Defined in: packages/react-native/src/types/NotificationAndroid.ts:812

URI contact of the person.

The URI can be any of the following:

• The representation of a contact URI, e.g. android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI
• A mailto: string
• A tel: string