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

Reference

Notifee provides Reference documentation for all publicly available APIs.

The public JavaScript API for React Native is written with TypeScript. The Notifee reference documentation is automatically generated to provide users with further detail into the full API.

API & Types

The reference documentation is broken down into two categories:

API

All publicly available methods which can be accessed from the imported library, for example:

import notifee from '@notifee/react-native';

notifee.cancelAllNotifications();

View the Basic Usage documentation for more information.

Types

Types are those which are publicly available to users to assist when using the library. The types documentation includes descriptions of individual properties which may not be covered in the general documentation. Types are available as named exports, for example:

import { AndroidColor, EventType } from '@notifee/react-native';

View the Basic Usage documentation for more information.


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.