Interface RealtimeSubscriptionRequest

interface RealtimeSubscriptionRequest {
    cursor?: string;
    deltaToken?: string;
    fields?: readonly string[];
    layerId?: string | number;
    metadata?: Readonly<Record<string, unknown>>;
    mode?: RealtimeSubscriptionMode;
    requestId?: string;
    resumeFrom?: RealtimeResumeCheckpoint;
    signal?: AbortSignal;
    sourceId: string;
    spatialFilter?: unknown;
    timestamp?: string;
    watermark?: string;
    where?: string;
}

Hierarchy (View Summary)

RealtimeSubscriptionIdentity
- RealtimeSubscriptionRequest

Index

Properties

cursor? deltaToken? fields? layerId? metadata? mode? requestId? resumeFrom? signal? sourceId spatialFilter? timestamp? watermark? where?

Properties

`Optional` `Readonly`cursor

cursor?: string

`Optional` `Readonly`deltaToken

deltaToken?: string

`Optional` `Readonly`fields

fields?: readonly string[]

`Optional` `Readonly`layerId

layerId?: string | number

`Optional` `Readonly`metadata

metadata?: Readonly<Record<string, unknown>>

`Optional` `Readonly`mode

mode?: RealtimeSubscriptionMode

`Optional` `Readonly`requestId

requestId?: string

Optional caller-owned logical subscription id. Use this when a UI needs to reconnect the same source/layer/filter request across page reloads.

`Optional` `Readonly`resumeFrom

resumeFrom?: RealtimeResumeCheckpoint

`Optional` `Readonly`signal

signal?: AbortSignal

`Readonly`sourceId

sourceId: string

`Optional` `Readonly`spatialFilter

spatialFilter?: unknown

`Optional` `Readonly`timestamp

timestamp?: string

`Optional` `Readonly`watermark

watermark?: string

`Optional` `Readonly`where

where?: string