Interface NotificationPreferenceArgs<Payload, Ctx>

Arguments passed to an app-owned notification preference evaluator.

interface NotificationPreferenceArgs<
    Payload extends StandardSchema = StandardSchema,
    Ctx = unknown,
> {
    channel: string;
    ctx: Ctx;
    metadata?: Record<string, unknown>;
    notification: NotificationDef<string, Payload, Ctx>;
    payload: InferSchemaOutput<Payload>;
}

Type Parameters

Payload extends StandardSchema = StandardSchema
Ctx = unknown

Hierarchy (View Summary)

NotificationChannelHandleArgs<Payload, Ctx>
- NotificationPreferenceArgs

Index

Properties

channel ctx metadata? notification payload

Properties

channel

channel: string

Channel name being delivered.

ctx

ctx: Ctx

Handler context.

`Optional`metadata

metadata?: Record<string, unknown>

Optional metadata supplied by the notification sender.

notification

notification: NotificationDef<string, Payload, Ctx>

Notification definition being delivered.

payload

payload: InferSchemaOutput<Payload>

Parsed notification payload.