Interface UnfilteredResponseQueryOptions

interface UnfilteredResponseQueryOptions {
    body?: any;
    cache?: undefined;
    cacheMode?: "noStale";
    filterResponse: false;
    headers?: Record<string, string>;
    lastLiveEventId?: null | string | string[];
    method?: string;
    next?: undefined;
    perspective?: ClientPerspective;
    query?: any;
    resultSourceMap?: boolean | "withKeyArraySelector";
    returnQuery?: true;
    signal?: AbortSignal;
    stega?: boolean | StegaConfig;
    tag?: string;
    timeout?: number;
    token?: string;
    useCdn?: boolean;
}

Hierarchy (View Summary)

Properties

body? cache? cacheMode? filterResponse headers? lastLiveEventId? method? next? perspective? query? resultSourceMap? returnQuery? signal? stega? tag? timeout? token? useCdn?

Properties

Optionalbody

body?: any

Optionalcache

cache?: undefined

OptionalcacheMode

cacheMode?: "noStale"

When set to noStale, APICDN will not return a cached response if the content is stale. Tradeoff between latency and freshness of content.

Only to be used with live content queries and when useCdn is true.

filterResponse

filterResponse: false

Optionalheaders

headers?: Record<string, string>

OptionallastLiveEventId

lastLiveEventId?: null | string | string[]

Optionalmethod

method?: string

Optionalnext

next?: undefined

Optionalperspective

perspective?: ClientPerspective

Optionalquery

query?: any

OptionalresultSourceMap

resultSourceMap?: boolean | "withKeyArraySelector"

OptionalreturnQuery

returnQuery?: true

When filterResponse is false, returnQuery also defaults to true for backwards compatibility (on the client side, not from the content lake API). Can also explicitly be set to true.

Optionalsignal

signal?: AbortSignal

Optionalstega

stega?: boolean | StegaConfig

Optionaltag

tag?: string

Optionaltimeout

timeout?: number

Optionaltoken

token?: string

OptionaluseCdn

useCdn?: boolean

Settings

Member Visibility

On This Page

Properties