The documentation is currently a work in progress whilst the product is in alpha.

AndroidPerson

Android Only

The interface used to describe a person shown in notifications.


Currently used with AndroidMessagingStyle notifications.

Properties

bot

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

bot?: undefined | false | true;

Defaults to false.

icon

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

icon?: undefined | string;

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

id

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..

id?: undefined | string;

important

If true this person will be marked as important.

important?: undefined | false | true;

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

The name of the person.

name: string;

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

uri

URI contact of the person.

uri?: undefined | string;

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

Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.