Papier
Get started
InterfaceSDK v0.3.0

PushAdapter

import type { PushAdapter } from '@usepapier/client/base';

Declaration #

types.tsTypeScript
export interface PushAdapter {
    name: string;
    supports: (target: PushTarget) => boolean;
    send: (input: PushAdapterInput, meta?: AdapterMeta) => Promise<{
        id?: string;
        provider?: string;
    }>;
}

Source: packages/client/src/push/types.ts:45

Members 3

name

name: string;

packages/client/src/push/types.ts:46

supports

supports: (target: PushTarget) => boolean;

Parameters

target
PushTarget

packages/client/src/push/types.ts:47

send

Resolves on provider acceptance, never on device delivery/display. Do not retry internally.

send: (input: PushAdapterInput, meta?: AdapterMeta) => Promise<{
    id?: string;
    provider?: string;
}>;

Parameters

input
PushAdapterInput
metaOptional
AdapterMeta

packages/client/src/push/types.ts:49

Generated from TypeScript source.b1e9ee529902