Udostępnij za pośrednictwem


ListMessagesOptions interface

Szczegóły używane do wyświetlania komunikatów.

Extends

Właściwości

after

Kursor do użycia w stronicacji. po jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład jeśli wysyłasz żądanie listy i odbierasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać ciąg after=obj_foo w celu pobrania następnej strony listy.

before

Kursor do użycia w stronicacji. przed jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład jeśli wysyłasz żądanie listy i odbierasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.

limit

Limit liczby obiektów, które mają zostać zwrócone. Limit może wahać się od 1 do 100, a wartość domyślna to 20.

order

Sortuj kolejność według znacznika czasu created_at obiektów. asc dla kolejności rosnącej i desc dla kolejności malejącej.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

after

Kursor do użycia w stronicacji. po jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład jeśli wysyłasz żądanie listy i odbierasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać ciąg after=obj_foo w celu pobrania następnej strony listy.

after?: string

Wartość właściwości

string

before

Kursor do użycia w stronicacji. przed jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład jeśli wysyłasz żądanie listy i odbierasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.

before?: string

Wartość właściwości

string

limit

Limit liczby obiektów, które mają zostać zwrócone. Limit może wahać się od 1 do 100, a wartość domyślna to 20.

limit?: number

Wartość właściwości

number

order

Sortuj kolejność według znacznika czasu created_at obiektów. asc dla kolejności rosnącej i desc dla kolejności malejącej.

order?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

Dziedziczone z OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

Dziedziczone z OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

Dziedziczone z OperationOptions.requestOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

Dziedziczone z OperationOptions.tracingOptions