ReceiveEventsOptionalParams interface
Typ opcji podstawowych dla wszystkich operacji.
- Rozszerzenie
Właściwości
| max |
Maksymalna liczba zdarzeń do odebrania. Wartość minimalna to 1, a wartość maksymalna to 100 zdarzeń. Jeśli nie zostanie określony, wartość domyślna to 1. |
| max |
Maksymalna wartość czasu oczekiwania dla operacji odbierania w sekundach. Jest to czas w sekundach, przez który serwer oczekuje na dostępność zdarzenia i odpowiada na żądanie. Jeśli zdarzenie jest dostępne, broker natychmiast odpowiada klientowi. Wartość minimalna to 10 sekund, a maksymalna wartość to 120 sekund. Jeśli nie zostanie określony, wartość domyślna to 60 sekund. |
Właściwości dziedziczone
| abort |
Sygnał, który może służyć do przerwania żądań. |
| on |
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. |
| request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| tracing |
Opcje używane podczas śledzenia są włączone. |
Szczegóły właściwości
maxEvents
Maksymalna liczba zdarzeń do odebrania. Wartość minimalna to 1, a wartość maksymalna to 100 zdarzeń. Jeśli nie zostanie określony, wartość domyślna to 1.
maxEvents?: number
Wartość właściwości
number
maxWaitTime
Maksymalna wartość czasu oczekiwania dla operacji odbierania w sekundach. Jest to czas w sekundach, przez który serwer oczekuje na dostępność zdarzenia i odpowiada na żądanie. Jeśli zdarzenie jest dostępne, broker natychmiast odpowiada klientowi. Wartość minimalna to 10 sekund, a maksymalna wartość to 120 sekund. Jeśli nie zostanie określony, wartość domyślna to 60 sekund.
maxWaitTime?: 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 zOperationOptions.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 zOperationOptions.onResponse
requestOptions
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
requestOptions?: OperationRequestOptions
Wartość właściwości
dziedziczone zOperationOptions.requestOptions
tracingOptions
Opcje używane podczas śledzenia są włączone.
tracingOptions?: OperationTracingOptions
Wartość właściwości
dziedziczone zOperationOptions.tracingOptions