Class HTTPRequestBody

Represents a HTTP request body that will be submitted to the remote server when the request is executed.

Hierarchy

  • FrameworkObject
    • HTTPRequestBody

Constructors

constructor

Accessors

bodyStream fileName isFile

Constructors

constructor

  • new HTTPRequestBody(): HTTPRequestBody

  • Returns HTTPRequestBody

  • new HTTPRequestBody(bodyContents, isFile?, fileName?, isInternalConstructor?): HTTPRequestBody

  • Parameters

    • bodyContents: string
    • OptionalisFile: boolean
    • OptionalfileName: string
    • OptionalisInternalConstructor: boolean

    Returns HTTPRequestBody

  • new HTTPRequestBody(stream, isFile?, fileName?): HTTPRequestBody

  • Parameters

    • stream: DataStream
    • OptionalisFile: boolean
    • OptionalfileName: string

    Returns HTTPRequestBody

Accessors

bodyStream

  • get bodyStream(): DataStream

  • Stream of data to send with the request.

    Returns DataStream

  • set bodyStream(value): void

  • Parameters

    Returns void

fileName

  • get fileName(): string

  • If part of a multipart request, specifies the name of the file.

    Returns string

  • set fileName(value): void

  • Parameters

    • value: string

    Returns void

isFile

  • get isFile(): boolean

  • True if the stream that represents a file to be saved.

    Returns boolean

  • set isFile(value): void

  • Parameters

    • value: boolean

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors