Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpRequestArgs

Arguments for sending an HTTP request.

Hierarchy

  • Dynamic
    • HttpRequestArgs

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.httpRequestArgs class with default values.

    Returns HttpRequestArgs

Properties

Private __headers

__headers: NameValueCollection
internal

Private _binaryContent

_binaryContent: Uint8Array
internal

Private _method

_method: HttpMethod
internal

Private _onRequestCreated

_onRequestCreated: IAction1<HttpRequestCreatedArgs>
internal

Private _onResponseReceived

_onResponseReceived: IAction1<HttpResponseReceivedArgs>
internal

Private _sender

_sender: Object
internal

Private _textContent

_textContent: string
internal

Private _timeout

_timeout: number
internal

Private _url

_url: string
internal

Methods

getBinaryContent

  • getBinaryContent(): Uint8Array
  • Gets the binary content to transfer over HTTP. Overrides fm.icelink.httpRequestArgs.textContent.

    Returns Uint8Array

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getHeaders

  • getHeaders(): NameValueCollection
  • Gets the headers to transfer over HTTP.

    Returns NameValueCollection

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getMethod

  • getMethod(): HttpMethod
  • Gets the HTTP method.

    Returns HttpMethod

getOnRequestCreated

  • getOnRequestCreated(): IAction1<HttpRequestCreatedArgs>
  • Gets the callback to invoke once the outgoing HTTP request is created. See fm.icelink.httpRequestCreatedArgs for callback argument details.

    Returns IAction1<HttpRequestCreatedArgs>

getOnResponseReceived

  • getOnResponseReceived(): IAction1<HttpResponseReceivedArgs>
  • Gets the callback to invoke once the incoming HTTP response has been received. See fm.icelink.httpResponseReceivedArgs for callback argument details.

    Returns IAction1<HttpResponseReceivedArgs>

getSender

  • getSender(): Object
  • Gets the sender of the content, either a client or publisher.

    Returns Object

getSerialized

  • getSerialized(): string

getTextContent

  • getTextContent(): string
  • Gets the text content to transfer over HTTP.

    Returns string

getTimeout

  • getTimeout(): number
  • Gets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).

    Returns number

getTypeString

  • getTypeString(): string

getUrl

  • getUrl(): string
  • Gets the target URL for the HTTP request.

    Returns string

setBinaryContent

  • setBinaryContent(value: Uint8Array): void
  • Sets the binary content to transfer over HTTP. Overrides fm.icelink.httpRequestArgs.textContent.

    Parameters

    • value: Uint8Array

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setHeaders

  • setHeaders(value: NameValueCollection): void
  • Sets the headers to transfer over HTTP.

    Parameters

    • value: NameValueCollection

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setMethod

  • setMethod(value: HttpMethod): void
  • Sets the HTTP method.

    Parameters

    • value: HttpMethod

    Returns void

setOnRequestCreated

  • setOnRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void
  • Sets the callback to invoke once the outgoing HTTP request is created. See fm.icelink.httpRequestCreatedArgs for callback argument details.

    Parameters

    • value: IAction1<HttpRequestCreatedArgs>

    Returns void

setOnResponseReceived

  • setOnResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void
  • Sets the callback to invoke once the incoming HTTP response has been received. See fm.icelink.httpResponseReceivedArgs for callback argument details.

    Parameters

    • value: IAction1<HttpResponseReceivedArgs>

    Returns void

setSender

  • setSender(value: Object): void
  • Sets the sender of the content, either a client or publisher.

    Parameters

    • value: Object

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTextContent

  • setTextContent(value: string): void
  • Sets the text content to transfer over HTTP.

    Parameters

    • value: string

    Returns void

setTimeout

  • setTimeout(value: number): void
  • Sets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).

    Parameters

    • value: number

    Returns void

setUrl

  • setUrl(value: string): void
  • Sets the target URL for the HTTP request.

    Parameters

    • value: string

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.