Sdílet prostřednictvím


ListMessagesOptions interface

Podrobnosti použité k výpisu zpráv.

Extends

Vlastnosti

after

Kurzor pro použití ve stránkování. after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, které končí na obj_foo, může další volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.

before

Kurzor pro použití ve stránkování. before je ID objektu, které definuje vaše místo v seznamu. Pokud například zadáte požadavek na seznam a obdržíte 100 objektů, které končí obj_foo, může následné volání obsahovat hodnotu before=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

limit

Omezení počtu objektů, které mají být vráceny. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.

order

Pořadí řazení podle časového razítka created_at objektů. asc pro vzestupné pořadí a desc pro sestupné pořadí.

Zděděné vlastnosti

abortSignal

Signál, který lze použít k přerušení požadavků.

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

tracingOptions

Možnosti použité při povoleném trasování.

Podrobnosti vlastnosti

after

Kurzor pro použití ve stránkování. after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, které končí na obj_foo, může další volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.

after?: string

Hodnota vlastnosti

string

before

Kurzor pro použití ve stránkování. before je ID objektu, které definuje vaše místo v seznamu. Pokud například zadáte požadavek na seznam a obdržíte 100 objektů, které končí obj_foo, může následné volání obsahovat hodnotu before=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

before?: string

Hodnota vlastnosti

string

limit

Omezení počtu objektů, které mají být vráceny. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.

limit?: number

Hodnota vlastnosti

number

order

Pořadí řazení podle časového razítka created_at objektů. asc pro vzestupné pořadí a desc pro sestupné pořadí.

order?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

Zděděno z OperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

Zděděno z OperationOptions.onResponse

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

Zděděno z OperationOptions.requestOptions

tracingOptions

Možnosti použité při povoleném trasování.

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

Zděděno z OperationOptions.tracingOptions