/ fm / liveswitch / HttpWebRequestTransfer

Class: HttpWebRequestTransfer

fm.liveswitch.HttpWebRequestTransfer

Hierarchy

• HttpTransfer

  ↳ HttpWebRequestTransfer

Table of contents

Constructors

• constructor

Properties

• _corsFailCache
• _corsSuccessCache
• _disableCors
• _disableJsonp
• _disablePostMessage
• _forceJsonp
• _pmFailCache
• _pmSuccessCache
• getPlatformCode

Methods

• getTypeString
• process
• send
• sendAsync
• sendBinary
• sendBinaryAsync
• sendInternal
• sendText
• sendTextAsync
• shutdown
• addOnSendFinish
• addOnSendStart
• addQueryToUrl
• canCors
• canPostMessage
• getDisableCors
• getDisableJsonp
• getDisablePostMessage
• getForceJsonp
• getRandomWildcardCharacter
• getWildcardCharacters
• removeOnSendFinish
• removeOnSendStart
• replaceWildcards
• setDisableCors
• setDisableJsonp
• setDisablePostMessage
• setForceJsonp
• setWildcardCharacters

Constructors

constructor

+ new HttpWebRequestTransfer(): HttpWebRequestTransfer

Returns: HttpWebRequestTransfer

Inherited from: HttpTransfer

Properties

_corsFailCache

▪ Private Static _corsFailCache: Hash<string, boolean>

---

_corsSuccessCache

▪ Private Static _corsSuccessCache: Hash<string, boolean>

---

_disableCors

▪ Private Static _disableCors: boolean= false

---

_disableJsonp

▪ Private Static _disableJsonp: boolean= false

---

_disablePostMessage

▪ Private Static _disablePostMessage: boolean= false

---

_forceJsonp

▪ Private Static _forceJsonp: boolean= false

---

_pmFailCache

▪ Private Static _pmFailCache: Hash<string, boolean>

---

_pmSuccessCache

▪ Private Static _pmSuccessCache: Hash<string, boolean>

---

getPlatformCode

▪ Static getPlatformCode: () => string

Type declaration:

▸ (): string

Returns: string

Methods

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: HttpTransfer

---

process

▸ process(requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): HttpResponseArgs

Parameters:

Name	Type
requestArgs	HttpRequestArgs
callback	IAction1<HttpResponseArgs>

Returns: HttpResponseArgs

---

send

▸ send(requestArgs: HttpRequestArgs): HttpResponseArgs

Sends a request synchronously.

Parameters:

Name	Type	Description
requestArgs	HttpRequestArgs	The request parameters.

Returns: HttpResponseArgs

The resulting response.

Inherited from: HttpTransfer

---

sendAsync

▸ sendAsync(requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): void

Sends a request asynchronously.

Parameters:

Name	Type	Description
requestArgs	HttpRequestArgs	The request parameters.
callback	IAction1<HttpResponseArgs>	The callback to execute with the resulting response.

Returns: void

Inherited from: HttpTransfer

---

sendBinary

▸ sendBinary(requestArgs: HttpRequestArgs): HttpResponseArgs

Parameters:

Name	Type
requestArgs	HttpRequestArgs

Returns: HttpResponseArgs

Overrides: HttpTransfer

---

sendBinaryAsync

▸ sendBinaryAsync(requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): void

Parameters:

Name	Type
requestArgs	HttpRequestArgs
callback	IAction1<HttpResponseArgs>

Returns: void

Overrides: HttpTransfer

---

sendInternal

▸ sendInternal(fn: IAction1<HttpWebRequestSendOptions>, cors: boolean, pm: boolean, requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): HttpResponseArgs

Parameters:

Name	Type
fn	IAction1<HttpWebRequestSendOptions>
cors	boolean
pm	boolean
requestArgs	HttpRequestArgs
callback	IAction1<HttpResponseArgs>

Returns: HttpResponseArgs

---

sendText

▸ sendText(requestArgs: HttpRequestArgs): HttpResponseArgs

Parameters:

Name	Type
requestArgs	HttpRequestArgs

Returns: HttpResponseArgs

Overrides: HttpTransfer

---

sendTextAsync

▸ sendTextAsync(requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): void

Parameters:

Name	Type
requestArgs	HttpRequestArgs
callback	IAction1<HttpResponseArgs>

Returns: void

Overrides: HttpTransfer

---

shutdown

▸ shutdown(): void

Returns: void

Overrides: HttpTransfer

---

addOnSendFinish

▸ StaticaddOnSendFinish(value: IAction1<HttpSendFinishArgs>): void

Adds a handler that is raised before an HTTP request is sent.

Parameters:

Name	Type
value	IAction1<HttpSendFinishArgs>

Returns: void

Inherited from: HttpTransfer

---

addOnSendStart

▸ StaticaddOnSendStart(value: IAction1<HttpSendStartArgs>): void

Adds a handler that is raised before an HTTP request is sent.

Parameters:

Name	Type
value	IAction1<HttpSendStartArgs>

Returns: void

Inherited from: HttpTransfer

---

addQueryToUrl

▸ StaticaddQueryToUrl(url: string, key: string): string

Escapes and adds a query parameter as a key/empty-value pair to a URL.

Parameters:

Name	Type	Description
url	string	The URL with the query to which the key/value should be added.
key	string	The key of the query parameter to add.

Returns: string

The original URL with the query parameter added.

Inherited from: HttpTransfer

▸ StaticaddQueryToUrl(url: string, key: string, value: string): string

Escapes and adds a query parameter as a key/value pair to a URL.

Parameters:

Name	Type	Description
url	string	The URL with the query to which the key/value should be added.
key	string	The key of the query parameter to add.
value	string	The value of the query parameter to add.

Returns: string

The original URL with the query parameter added.

Inherited from: HttpTransfer

---

canCors

▸ StaticcanCors(): boolean

Returns: boolean

---

canPostMessage

▸ StaticcanPostMessage(): boolean

Returns: boolean

---

getDisableCors

▸ StaticgetDisableCors(): boolean

Returns: boolean

---

getDisableJsonp

▸ StaticgetDisableJsonp(): boolean

Returns: boolean

---

getDisablePostMessage

▸ StaticgetDisablePostMessage(): boolean

Returns: boolean

---

getForceJsonp

▸ StaticgetForceJsonp(): boolean

Returns: boolean

---

getRandomWildcardCharacter

▸ StaticgetRandomWildcardCharacter(): string

Gets a random wildcard character.

Returns: string

A random wildcard character.

Inherited from: HttpTransfer

---

getWildcardCharacters

▸ StaticgetWildcardCharacters(): string

Gets the wildcard characters used to replace asterisks in ReplaceWildcards.

Returns: string

Inherited from: HttpTransfer

---

removeOnSendFinish

▸ StaticremoveOnSendFinish(value: IAction1<HttpSendFinishArgs>): void

Removes a handler that is raised before an HTTP request is sent.

Parameters:

Name	Type
value	IAction1<HttpSendFinishArgs>

Returns: void

Inherited from: HttpTransfer

---

removeOnSendStart

▸ StaticremoveOnSendStart(value: IAction1<HttpSendStartArgs>): void

Removes a handler that is raised before an HTTP request is sent.

Parameters:

Name	Type
value	IAction1<HttpSendStartArgs>

Returns: void

Inherited from: HttpTransfer

---

replaceWildcards

▸ StaticreplaceWildcards(url: string): string

Replaces asterisks in URLs with characters from WildcardCharacters.

Parameters:

Name	Type	Description
url	string	The URL with asterisks.

Returns: string

Inherited from: HttpTransfer

---

setDisableCors

▸ StaticsetDisableCors(disableCors: boolean): void

Parameters:

Name	Type
disableCors	boolean

Returns: void

---

setDisableJsonp

▸ StaticsetDisableJsonp(disableJsonp: boolean): void

Parameters:

Name	Type
disableJsonp	boolean

Returns: void

---

setDisablePostMessage

▸ StaticsetDisablePostMessage(disablePostMessage: boolean): void

Parameters:

Name	Type
disablePostMessage	boolean

Returns: void

---

setForceJsonp

▸ StaticsetForceJsonp(forceJsonp: boolean): void

Parameters:

Name	Type
forceJsonp	boolean

Returns: void

---

setWildcardCharacters

▸ StaticsetWildcardCharacters(value: string): void

Sets the wildcard characters used to replace asterisks in ReplaceWildcards.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: HttpTransfer