/ fm / liveswitch / HttpResponseArgs
Class: HttpResponseArgs
fm.liveswitch.HttpResponseArgs
Arguments for receiving an HTTP response.
Table of contents
Constructors
Methods
- fmliveswitchHttpResponseArgsInit
- getBinaryContent
- getException
- getHeaders
- getRequestArgs
- getRetries
- getStatusCode
- getTextContent
- getTypeString
- setBinaryContent
- setException
- setRequestArgs
- setRetries
- setStatusCode
- setTextContent
Constructors
constructor
+ new HttpResponseArgs(): HttpResponseArgs
Returns: HttpResponseArgs
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:31
+ new HttpResponseArgs(requestArgs
: HttpRequestArgs): HttpResponseArgs
Initializes a new instance of the [[fm.liveswitch.httpResponseArgs]] class.
Parameters:
Name | Type | Description |
---|---|---|
requestArgs |
HttpRequestArgs | The request arguments. |
Returns: HttpResponseArgs
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:32
Methods
fmliveswitchHttpResponseArgsInit
▸ Private
fmliveswitchHttpResponseArgsInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:27
getBinaryContent
▸ getBinaryContent(): Uint8Array
Gets the binary content read from the HTTP response.
Returns: Uint8Array
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:68
getException
▸ getException(): Exception
Gets the exception generated while completing the request.
Returns: Exception
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:80
getHeaders
▸ getHeaders(): NameValueCollection
Gets the headers read from the HTTP response.
Returns: NameValueCollection
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:92
getRequestArgs
▸ getRequestArgs(): HttpRequestArgs
Gets the original [[fm.liveswitch.httpRequestArgs]].
Returns: HttpRequestArgs
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:104
getRetries
▸ getRetries(): number
Gets the number of retries that were required.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:116
getStatusCode
▸ getStatusCode(): number
Gets the status code read from the HTTP response.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:128
getTextContent
▸ getTextContent(): string
Gets the text content read from the HTTP response.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:140
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:9
setBinaryContent
▸ setBinaryContent(value
: Uint8Array): void
Sets the binary content read from the HTTP response.
Parameters:
Name | Type |
---|---|
value |
Uint8Array |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:152
setException
▸ setException(value
: Exception): void
Sets the exception generated while completing the request.
Parameters:
Name | Type |
---|---|
value |
Exception |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:164
setRequestArgs
▸ setRequestArgs(value
: HttpRequestArgs): void
Sets the original [[fm.liveswitch.httpRequestArgs]].
Parameters:
Name | Type |
---|---|
value |
HttpRequestArgs |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:184
setRetries
▸ setRetries(value
: number): void
Sets the number of retries that were required.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:196
setStatusCode
▸ setStatusCode(value
: number): void
Sets the status code read from the HTTP response.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:209
setTextContent
▸ setTextContent(value
: string): void
Sets the text content read from the HTTP response.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/HttpResponseArgs.ts:222