Search Results for

    / fm / liveswitch / HttpTransfer

    Class: HttpTransfer

    fm.liveswitch.HttpTransfer

    Base class that defines methods for transferring content over HTTP.

    Hierarchy

    • HttpTransfer

      ↳ HttpWebRequestTransfer

    Table of contents

    Constructors

    • constructor

    Methods

    • getTypeString
    • send
    • sendAsync
    • sendBinary
    • sendBinaryAsync
    • sendText
    • sendTextAsync
    • shutdown
    • addOnSendFinish
    • addOnSendStart
    • addQueryToUrl
    • getRandomWildcardCharacter
    • getWildcardCharacters
    • removeOnSendFinish
    • removeOnSendStart
    • replaceWildcards
    • setWildcardCharacters

    Constructors

    constructor

    + new HttpTransfer(): HttpTransfer

    Returns: HttpTransfer

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:23

    Methods

    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:9


    send

    ▸ send(requestArgs: HttpRequestArgs): HttpResponseArgs

    Sends a request synchronously.

    Parameters:

    Name Type Description
    requestArgs HttpRequestArgs The request parameters.

    Returns: HttpResponseArgs

    The resulting response.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:296


    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

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:323


    sendBinary

    ▸ AbstractsendBinary(requestArgs: HttpRequestArgs): HttpResponseArgs

    Sends binary content synchronously using the specified arguments.

    Parameters:

    Name Type Description
    requestArgs HttpRequestArgs The request arguments.

    Returns: HttpResponseArgs

    The response arguments from the server.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:357


    sendBinaryAsync

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

    Sends binary content asynchronously using the specified arguments.

    Parameters:

    Name Type Description
    requestArgs HttpRequestArgs The request arguments.
    callback IAction1<HttpResponseArgs> The callback to execute on success or failure.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:365


    sendText

    ▸ AbstractsendText(requestArgs: HttpRequestArgs): HttpResponseArgs

    Sends text content synchronously using the specified arguments.

    Parameters:

    Name Type Description
    requestArgs HttpRequestArgs The request arguments.

    Returns: HttpResponseArgs

    The response arguments from the server.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:373


    sendTextAsync

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

    Sends text content asynchronously using the specified arguments.

    Parameters:

    Name Type Description
    requestArgs HttpRequestArgs The request arguments.
    callback IAction1<HttpResponseArgs> The callback to execute on success or failure.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:381


    shutdown

    ▸ Abstractshutdown(): void

    Releases any resources and shuts down.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:387


    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

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:42


    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

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:55


    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.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:71

    ▸ 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.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:81


    getRandomWildcardCharacter

    ▸ StaticgetRandomWildcardCharacter(): string

    Gets a random wildcard character.

    Returns: string

    A random wildcard character.

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:111


    getWildcardCharacters

    ▸ StaticgetWildcardCharacters(): string

    Gets the wildcard characters used to replace asterisks in ReplaceWildcards.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:127


    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

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


    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

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:153


    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

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:168


    setWildcardCharacters

    ▸ StaticsetWildcardCharacters(value: string): void

    Sets the wildcard characters used to replace asterisks in ReplaceWildcards.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/HttpTransfer.ts:182

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