InterfaceSDK v0.3.0

PushUserInput

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

Declaration #

types.tsTypeScript
export interface PushUserInput<TData = Record<string, unknown>> extends PushDeliveryOptions {
    to: PushTarget;
    data: TData;
}

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

Members 6

to: PushTarget;

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

data: TData;

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

ttl

OptionalFrom PushDeliveryOptions
ttl?: number | undefined;

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

urgency

OptionalFrom PushDeliveryOptions
urgency?: "very-low" | "low" | "normal" | "high" | undefined;

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

topic

OptionalFrom PushDeliveryOptions

RFC 8030 replacement topic, at most 32 URL-safe characters (Web Push only).

topic?: string | undefined;

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

idempotencyKey

OptionalFrom PushDeliveryOptions

Makes a retried send safe when delivering through Papier.

idempotencyKey?: string | undefined;

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

Generated from TypeScript source.b1e9ee529902