Class MessageAbstract

Hierarchy

Constructors

constructor

Properties

_responseType _tokenStorage progressCallback request withCredentials BINARY StatusCode

Accessors

isBinary spec

Methods

accept acl addQueryString cacheControl contentLength customHeaders doReceive entity formatETag header ifMatch ifNoneMatch ifUnmodifiedSince mimeType noCache path progress responseType tokenStorage create

Constructors

constructor

  • Parameters

    • Rest ...args: string[]

      The path arguments

    Returns Message

Properties

Private _responseType

_responseType: null | ResponseBodyType = null

Private _tokenStorage

_tokenStorage: null | TokenStorage = null

progressCallback

progressCallback: null | ProgressListener = null

request

request: Request

withCredentials

withCredentials: boolean = false

Static Readonly BINARY

BINARY: {
    arraybuffer: boolean;
    base64: boolean;
    blob: boolean;
    buffer: boolean;
    data-url: boolean;
    stream: boolean;
} = ...

Type declaration

  • arraybuffer: boolean
  • base64: boolean
  • blob: boolean
  • buffer: boolean
  • data-url: boolean
  • stream: boolean

Static Readonly StatusCode

StatusCode: {
    BAD_CREDENTIALS: number;
    BUCKET_NOT_FOUND: number;
    FORBIDDEN: number;
    INVALID_PERMISSION_MODIFICATION: number;
    INVALID_TYPE_VALUE: number;
    NOT_MODIFIED: number;
    OBJECT_NOT_FOUND: number;
    OBJECT_OUT_OF_DATE: number;
    PERMISSION_DENIED: number;
    QUERY_DISPOSED: number;
    QUERY_NOT_SUPPORTED: number;
    SCHEMA_NOT_COMPATIBLE: number;
    SCHEMA_STILL_EXISTS: number;
    SCRIPT_ABORTION: number;
    SYNTAX_ERROR: number;
    TRANSACTION_INACTIVE: number;
    TYPE_ALREADY_EXISTS: number;
    TYPE_STILL_REFERENCED: number;
} = StatusCode

Type declaration

  • BAD_CREDENTIALS: number
  • BUCKET_NOT_FOUND: number
  • FORBIDDEN: number
  • INVALID_PERMISSION_MODIFICATION: number
  • INVALID_TYPE_VALUE: number
  • NOT_MODIFIED: number
  • OBJECT_NOT_FOUND: number
  • OBJECT_OUT_OF_DATE: number
  • PERMISSION_DENIED: number
  • QUERY_DISPOSED: number
  • QUERY_NOT_SUPPORTED: number
  • SCHEMA_NOT_COMPATIBLE: number
  • SCHEMA_STILL_EXISTS: number
  • SCRIPT_ABORTION: number
  • SYNTAX_ERROR: number
  • TRANSACTION_INACTIVE: number
  • TYPE_ALREADY_EXISTS: number
  • TYPE_STILL_REFERENCED: number

Accessors

isBinary

  • get isBinary(): boolean

  • Returns boolean

spec

  • get spec(): MessageSpec

  • Returns the specification of this message

    Returns MessageSpec

Methods

accept

  • Gets the request accept header

    Returns

    Returns string

  • Sets the request accept header

    Returns

    This message object

    Parameters

    • accept: string

      the accept header value

    Returns Message

acl

  • Gets the ACL of a file into the Baqend-Acl header

    Returns

    Returns string

  • Sets and encodes the ACL of a file into the Baqend-Acl header

    Returns

    This message object

    Parameters

    • acl: Acl

      the file ACLs

    Returns Message

addQueryString

  • Adds the given string to the request path

    If the parameter is an object, it will be serialized as a query string.

    Returns

    Parameters

    • query: string | {
          [key: string]: string;
      }

      which will added to the request path

    Returns Message

cacheControl

  • Gets the cache control header

    Returns

    Returns string

  • Sets the cache control header

    Returns

    This message object

    Parameters

    • value: string

      The cache control flags

    Returns Message

contentLength

  • Gets the contentLength

    Returns

    Returns number

  • Sets the contentLength

    Returns

    This message object

    Parameters

    • contentLength: number

      the content length of the data

    Returns Message

customHeaders

  • Gets and encodes the custom headers of a file into the Baqend-Custom-Headers header

    Returns

    Returns string

  • Sets and encodes the custom headers of a file into the Baqend-Custom-Headers header

    Returns

    This message object

    Parameters

    • customHeaders: {
          [headers: string]: string;
      }

      the file custom headers

      • [headers: string]: string

    Returns Message

doReceive

  • Handle the receive

    Returns

    Parameters

    • response: Response

      The received response headers and data

    Returns void

entity

  • Sets the entity type

    Returns

    This message object

    Parameters

    • data: RequestBody

      The data to send

    • Optional type: RequestBodyType

      the type of the data one of 'json'|'text'|'blob'|'arraybuffer' defaults detect the type based on the body data

    Returns Message

formatETag

  • Parameters

    • Optional eTag: null | string | number

    Returns undefined | null | string

header

  • Gets the value of a the specified request header

    Returns

    The header value

    Parameters

    • name: string

      The header name

    Returns string

  • Sets the value of a the specified request header

    Returns

    This message object

    Parameters

    • name: string

      The header name

    • value: null | string

      The header value if omitted the value will be returned

    Returns Message

  • Parameters

    • name: string
    • Optional value: null | string

    Returns string | Message

ifMatch

  • Gets the request conditional If-Match header

    Returns

    This message object

    Returns string

  • Sets the request conditional If-Match header

    Returns

    This message object

    Parameters

    • eTag: null | string | number

      the If-Match ETag value

    Returns Message

ifNoneMatch

  • Gets the request a ETag based conditional header

    Returns

    Returns string

  • Sets the request a ETag based conditional header

    Returns

    This message object

    Parameters

    • eTag: string

      The ETag value

    Returns Message

ifUnmodifiedSince

  • Gets the request date based conditional header

    Returns

    Returns string

  • Sets the request date based conditional header

    Returns

    This message object

    Parameters

    • date: Date

      The date value

    Returns Message

mimeType

  • Get the mimeType

    Returns

    This message object

    Returns string

  • Sets the mimeType

    Returns

    This message object

    Parameters

    • mimeType: null | string

      the mimeType of the data

    Returns Message

noCache

  • Indicates that the request should not be served by a local cache

    Returns

    Returns Message

path

  • Gets the request path

    Returns

    The path of the message value

    Returns string

  • Sets the request path

    Returns

    This message object

    Parameters

    • path: string

      The new path value, any query parameters provided with the path will be merged with the exiting query params

    Returns Message

progress

responseType

  • Gets the response type which should be returned

    Returns

    This message object

    Returns null | ResponseBodyType

  • Sets the response type which should be returned

    Returns

    This message object

    Parameters

    • type: null | ResponseBodyType

      The response type one of 'json'|'text'|'blob'|'arraybuffer' defaults to 'json'

    Returns Message

tokenStorage

  • Gets the tokenStorage which stored credentials are used to authorize this message

    Returns

    The header value

    Returns null | TokenStorage

  • Sets the tokenStorage which stored credentials are used to authorize this message

    Returns

    This message object

    Parameters

    • value: null | TokenStorage

      The new tokenStorage used to authorize this message

    Returns Message

Static create

  • Creates a new message class with the given message specification

    Returns

    A created message object for the specification

    Type Parameters

    • T

    Parameters

    Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc