Search Results for

    / fm / liveswitch / HttpRequestArgs

    Class: HttpRequestArgs

    fm.liveswitch.HttpRequestArgs

    Arguments for sending an HTTP request.

    Hierarchy

    • Dynamic

      ↳ HttpRequestArgs

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchHttpRequestArgsInit
    • getBinaryContent
    • getDynamicProperties
    • getDynamicValue
    • getHeaders
    • getMaxRetries
    • getMethod
    • getOnRequestCreated
    • getOnResponseReceived
    • getSender
    • getTextContent
    • getTimeout
    • getTypeString
    • getUrl
    • setBinaryContent
    • setDynamicValue
    • setHeaders
    • setMaxRetries
    • setMethod
    • setOnRequestCreated
    • setOnResponseReceived
    • setSender
    • setTextContent
    • setTimeout
    • setUrl
    • unsetDynamicValue

    Constructors

    constructor

    + new HttpRequestArgs(): HttpRequestArgs

    Initializes a new instance of the [[fm.liveswitch.httpRequestArgs]] class with default values.

    Returns: HttpRequestArgs

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:38

    Methods

    fmliveswitchHttpRequestArgsInit

    ▸ PrivatefmliveswitchHttpRequestArgsInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:34


    getBinaryContent

    ▸ getBinaryContent(): Uint8Array

    Gets the binary content to transfer over HTTP. Overrides [[fm.liveswitch.httpRequestArgs.textContent]].

    Returns: Uint8Array

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:66


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37


    getDynamicValue

    ▸ getDynamicValue(key: string): Object

    Gets a property value from the local cache.

    Parameters:

    Name Type Description
    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.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58


    getHeaders

    ▸ getHeaders(): NameValueCollection

    Gets the headers to transfer over HTTP.

    Returns: NameValueCollection

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:78


    getMaxRetries

    ▸ getMaxRetries(): number

    Gets the maximum number of retries allowed.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:90


    getMethod

    ▸ getMethod(): HttpMethod

    Gets the HTTP method.

    Returns: HttpMethod

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:102


    getOnRequestCreated

    ▸ getOnRequestCreated(): IAction1<HttpRequestCreatedArgs>

    Gets the callback to invoke once the outgoing HTTP request is created. See [[fm.liveswitch.httpRequestCreatedArgs]] for callback argument details.

    Returns: IAction1<HttpRequestCreatedArgs>

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:115


    getOnResponseReceived

    ▸ getOnResponseReceived(): IAction1<HttpResponseReceivedArgs>

    Gets the callback to invoke once the incoming HTTP response has been received. See [[fm.liveswitch.httpResponseReceivedArgs]] for callback argument details.

    Returns: IAction1<HttpResponseReceivedArgs>

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:128


    getSender

    ▸ getSender(): Object

    Gets the sender of the content, either a client or publisher.

    Returns: Object

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:140


    getTextContent

    ▸ getTextContent(): string

    Gets the text content to transfer over HTTP.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:152


    getTimeout

    ▸ getTimeout(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:165


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:10


    getUrl

    ▸ getUrl(): string

    Gets the target URL for the HTTP request.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:177


    setBinaryContent

    ▸ setBinaryContent(value: Uint8Array): void

    Sets the binary content to transfer over HTTP. Overrides [[fm.liveswitch.httpRequestArgs.textContent]].

    Parameters:

    Name Type
    value Uint8Array

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:190


    setDynamicValue

    ▸ setDynamicValue(key: string, value: Object): void

    Sets a property value in the local cache.

    Parameters:

    Name Type Description
    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

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95


    setHeaders

    ▸ setHeaders(value: NameValueCollection): void

    Sets the headers to transfer over HTTP.

    Parameters:

    Name Type
    value NameValueCollection

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:202


    setMaxRetries

    ▸ setMaxRetries(value: number): void

    Sets the maximum number of retries allowed.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:218


    setMethod

    ▸ setMethod(value: HttpMethod): void

    Sets the HTTP method.

    Parameters:

    Name Type
    value HttpMethod

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:231


    setOnRequestCreated

    ▸ setOnRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void

    Sets the callback to invoke once the outgoing HTTP request is created. See [[fm.liveswitch.httpRequestCreatedArgs]] for callback argument details.

    Parameters:

    Name Type
    value IAction1<HttpRequestCreatedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:244


    setOnResponseReceived

    ▸ setOnResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void

    Sets the callback to invoke once the incoming HTTP response has been received. See [[fm.liveswitch.httpResponseReceivedArgs]] for callback argument details.

    Parameters:

    Name Type
    value IAction1<HttpResponseReceivedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:257


    setSender

    ▸ setSender(value: Object): void

    Sets the sender of the content, either a client or publisher.

    Parameters:

    Name Type
    value Object

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:269


    setTextContent

    ▸ setTextContent(value: string): void

    Sets the text content to transfer over HTTP.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:281


    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:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:294


    setUrl

    ▸ setUrl(value: string): void

    Sets the target URL for the HTTP request.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpRequestArgs.ts:307


    unsetDynamicValue

    ▸ unsetDynamicValue(key: string): boolean

    Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

    Parameters:

    Name Type Description
    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.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0