Delen via


CommunicationsListOptionalParams interface

Optionele parameters.

Extends

OperationOptions

Eigenschappen

filter

Het filter dat moet worden toegepast op de bewerking. U kunt filteren op de eigenschappen communicationType en createdDate. CommunicationType ondersteunt de operator Equals ('eq') en createdDate ondersteunt de operators Greater Than ('gt') en Greater Than of Equals ('ge'). U kunt de filters CommunicationType en CreatedDate combineren met de operator Logical And ('and').

top

Het aantal waarden dat in de verzameling moet worden geretourneerd. De standaardwaarde is 10 en het maximum is 10.

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

onResponse

Een functie die moet worden aangeroepen telkens wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

filter

Het filter dat moet worden toegepast op de bewerking. U kunt filteren op de eigenschappen communicationType en createdDate. CommunicationType ondersteunt de operator Equals ('eq') en createdDate ondersteunt de operators Greater Than ('gt') en Greater Than of Equals ('ge'). U kunt de filters CommunicationType en CreatedDate combineren met de operator Logical And ('and').

filter?: undefined | string

Waarde van eigenschap

undefined | string

top

Het aantal waarden dat in de verzameling moet worden geretourneerd. De standaardwaarde is 10 en het maximum is 10.

top?: undefined | number

Waarde van eigenschap

undefined | number

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

Overgenomen van OperationOptions.abortSignal

onResponse

Een functie die moet worden aangeroepen telkens wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

Overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

Overgenomen van OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

Overgenomen van OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

Overgenomen van OperationOptions.tracingOptions