ListDocumentStatusesOptionalParams interface

Pakket:

@azure/ai-translation-document

Optionele parameters.

Uitbreiding

OperationOptions

Eigenschappen

createdAfter	de begindatum/tijd voor het ophalen van items na
createdBefore	de einddatum voor het ophalen van items vóór
documentIds	Id's die moeten worden gebruikt bij filteren
maxPageSize	maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd),
orderBy	de sorteerzoeking voor de collectie (bijv. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc beschrijving')
skip	Skip geeft het aantal records aan dat overgeslaan moet worden uit de lijst van records die door de server worden beheerd, gebaseerd op de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd. Clients MOGEN top- en skipqueryparameters gebruiken om een aantal resultaten te specificeren die teruggegeven moeten worden en een offset in de collectie. Wanneer zowel top als skip door een client worden gegeven, MOET de server eerst skip en daarna top toepassen op de collectie. Opmerking: Als de server top en/of skip niet kan honoreren, MOET de server een foutmelding geven aan de client om dit te melden in plaats van de query-opties gewoon te negeren.
statuses	Statussen die moeten worden gebruikt bij filteren
top	top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven. Clients MOGEN top- en skipqueryparameters gebruiken om een aantal resultaten te specificeren die teruggegeven moeten worden en een offset in de collectie. Wanneer zowel top als skip door een client worden gegeven, MOET de server eerst skip en daarna top toepassen op de collectie. Opmerking: Als de server top en/of skip niet kan honoreren, MOET de server een foutmelding geven aan de client om dit te melden in plaats van de query-opties gewoon te negeren.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer 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.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

createdAfter

de begindatum/tijd voor het ophalen van items na

createdAfter?: Date

Waarde van eigenschap

Date

createdBefore

de einddatum voor het ophalen van items vóór

createdBefore?: Date

Waarde van eigenschap

Date

documentIds

Id's die moeten worden gebruikt bij filteren

documentIds?: string[]

Waarde van eigenschap

string[]

maxPageSize

maxPageSize is het maximale aantal items dat in een pagina wordt teruggegeven. Als er via top meer items worden aangevraagd (of top is niet gespecificeerd en er meer items moeten worden teruggestuurd),

maxPageSize?: number

Waarde van eigenschap

number

orderBy

de sorteerzoeking voor de collectie (bijv. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc beschrijving')

orderBy?: string[]

Waarde van eigenschap

string[]

skip

Skip geeft het aantal records aan dat overgeslaan moet worden uit de lijst van records die door de server worden beheerd, gebaseerd op de gespecificeerde sorteermethode. Standaard sorteren we op aflopende begintijd.

Clients MOGEN top- en skipqueryparameters gebruiken om een aantal resultaten te specificeren die teruggegeven moeten worden en een offset in de collectie. Wanneer zowel top als skip door een client worden gegeven, MOET de server eerst skip en daarna top toepassen op de collectie.

Opmerking: Als de server top en/of skip niet kan honoreren, MOET de server een foutmelding geven aan de client om dit te melden in plaats van de query-opties gewoon te negeren.

skip?: number

Waarde van eigenschap

number

statuses

Statussen die moeten worden gebruikt bij filteren

statuses?: string[]

Waarde van eigenschap

string[]

top

top geeft het totale aantal records aan dat de gebruiker over alle pagina's wil teruggeven.

Clients MOGEN top- en skipqueryparameters gebruiken om een aantal resultaten te specificeren die teruggegeven moeten worden en een offset in de collectie. Wanneer zowel top als skip door een client worden gegeven, MOET de server eerst skip en daarna top toepassen op de collectie.

Opmerking: Als de server top en/of skip niet kan honoreren, MOET de server een foutmelding geven aan de client om dit te melden in plaats van de query-opties gewoon te negeren.

top?: number

Waarde van eigenschap

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 telkens wordt aangeroepen wanneer 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

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions