Stone.js API
    Preparing search index...

    Interface Recipient

    Who a notification is for.

    Deliberately thin, and open. This module has no idea what a person is in your application, and it must not: the only thing a notification library cannot ship is your idea of a person. What it needs is where to reach them, and in which language.

    interface Recipient {
        deviceTokens?: string[];
        email?: string;
        id?: string;
        locale?: string;
        phone?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Anything a channel of your own needs.

    Index
    deviceTokens? email? id? locale? phone?
    deviceTokens?: string[]

    Where to push. Registering and storing them is the application's business.

    email?: string

    Where to write.

    id?: string

    Whatever the application calls this person. Used to address the in-app channel.

    locale?: string

    The language this person reads, which is not the language of the request.

    phone?: string

    Where to text.

    Settings
    Member Visibility

    On This Page
    Properties