WebResource class
Crea un nuovo oggetto WebResource.
Questa classe fornisce un'astrazione su una chiamata REST essendo indipendente dalla libreria/implementazione e eseguendo il wrapping delle proprietà necessarie per avviare una richiesta.
Costruttori
Proprietà
| abort |
|
| agent |
|
| body | |
| form |
|
| headers | |
| keep |
|
| method | |
| on |
Callback che viene attivato all'avanzamento del download. |
| on |
Callback che viene attivato al momento dell'avanzamento del caricamento. |
| operation |
Funzione che restituisce la combinazione OperationResponse corretta per la combinazione OperationSpec e HttpOperationResponse specificata. Se non è definito, verrà usata una semplice ricerca del codice di stato. |
| operation |
|
| proxy |
|
| query | |
| redirect |
|
| should |
Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato. |
| stream |
Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso. |
| timeout | |
| url | |
| with |
Metodi
| clone() | Clonare questo oggetto richiesta HTTP WebResource. |
| prepare(Request |
Prepara la richiesta. |
| validate |
Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita. |
Dettagli costruttore
WebResource(string, HttpMethods, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number)
new WebResource(url?: string, method?: HttpMethods, body?: any, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, agentSettings?: AgentSettings, redirectLimit?: number)Parametri
- url
-
string
- method
- HttpMethods
- body
-
any
- query
-
{[key: string]: any}
- headers
-
{[key: string]: any} | HttpHeadersLike
- streamResponseBody
-
boolean
- withCredentials
-
boolean
- abortSignal
- AbortSignalLike
- timeout
-
number
- onUploadProgress
-
(progress: TransferProgressEvent) => void
- onDownloadProgress
-
(progress: TransferProgressEvent) => void
- proxySettings
- ProxySettings
- keepAlive
-
boolean
- agentSettings
- AgentSettings
- redirectLimit
-
number
Dettagli proprietà
abortSignal
agentSettings
body
body?: anyValore della proprietà
any
formData
formData?: anyValore della proprietà
any
headers
keepAlive
keepAlive?: booleanValore della proprietà
boolean
method
onDownloadProgress
Callback che viene attivato all'avanzamento del download.
onDownloadProgress?: (progress: TransferProgressEvent) => voidValore della proprietà
(progress: TransferProgressEvent) => void
onUploadProgress
Callback che viene attivato al momento dell'avanzamento del caricamento.
onUploadProgress?: (progress: TransferProgressEvent) => voidValore della proprietà
(progress: TransferProgressEvent) => void
operationResponseGetter
Funzione che restituisce la combinazione OperationResponse corretta per la combinazione OperationSpec e HttpOperationResponse specificata. Se non è definito, verrà usata una semplice ricerca del codice di stato.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseValore della proprietà
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
query?: {[key: string]: any}Valore della proprietà
{[key: string]: any}
redirectLimit
redirectLimit?: numberValore della proprietà
number
shouldDeserialize
Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanValore della proprietà
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso.
streamResponseBody?: booleanValore della proprietà
boolean
timeout
timeout: numberValore della proprietà
number
url
url: stringValore della proprietà
string
withCredentials
withCredentials: booleanValore della proprietà
boolean
Dettagli metodo
clone()
Clonare questo oggetto richiesta HTTP WebResource.
function clone(): WebResourceRestituisce
Clone di questo oggetto richiesta HTTP WebResource.
prepare(RequestPrepareOptions)
Prepara la richiesta.
function prepare(options: RequestPrepareOptions): WebResourceParametri
- options
- RequestPrepareOptions
Opzioni da fornire per preparare la richiesta.
Restituisce
Restituisce l'oggetto WebResource (richiesta HTTP) preparato che deve essere assegnato alla pipeline di richiesta.
validateRequestProperties()
Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita.
function validateRequestProperties()