Udostępnij za pośrednictwem


CommunicationsListOptionalParams interface

Parametry opcjonalne.

Extends

Właściwości

filter

Filtr, który ma być stosowany do operacji. Można filtrować według właściwości communicationType i createdDate. Funkcja CommunicationType obsługuje operator Equals ('eq') i createdDate obsługuje operatory Greater Than ('gt') i Greater Than lub Equals ('ge'). Filtry CommunicationType i CreatedDate można połączyć za pomocą operatora Logical And ('and').

top

Liczba wartości do zwrócenia w kolekcji. Wartość domyślna to 10, a wartość maksymalna to 10.

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.

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

tracingOptions

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

Szczegóły właściwości

filter

Filtr, który ma być stosowany do operacji. Można filtrować według właściwości communicationType i createdDate. Funkcja CommunicationType obsługuje operator Equals ('eq') i createdDate obsługuje operatory Greater Than ('gt') i Greater Than lub Equals ('ge'). Filtry CommunicationType i CreatedDate można połączyć za pomocą operatora Logical And ('and').

filter?: string

Wartość właściwości

string

top

Liczba wartości do zwrócenia w kolekcji. Wartość domyślna to 10, a wartość maksymalna to 10.

top?: number

Wartość właściwości

number

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 coreClient.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 coreClient.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 coreClient.OperationOptions.requestOptions

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.tracingOptions