Class: Message

connector.Message()

new Message()

Parameters:
Name Type Description
arguments... string

The path arguments

Source:

Members

(static) StatusCode :number

Type:
  • number
Properties:
Name Type Description
NOT_MODIFIED number
BAD_CREDENTIALS number
BUCKET_NOT_FOUND number
INVALID_PERMISSION_MODIFICATION number
INVALID_TYPE_VALUE 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
SYNTAX_ERROR number
TRANSACTION_INACTIVE number
TYPE_ALREADY_EXISTS number
TYPE_STILL_REFERENCED number
SCRIPT_ABORTION number
Source:

progressCallback :connector.Message~progressCallback

Type:
Source:

spec :Object

The message specification

Type:
  • Object
Source:

tokenStorage :util.TokenStorage

Type:
Source:

withCredentials :boolean

Type:
  • boolean
Source:

Methods

(static) create(specification) → {Class.<Message>}

Creates a new message class with the given message specification

Parameters:
Name Type Description
specification Object
Source:
Returns:
Type
Class.<Message>

(static) createExternal(specification, members) → {Class.<Message>}

Creates a new message class with the given message specification and a full path

Parameters:
Name Type Description
specification Object
members Object

additional members applied to the created message

Source:
Returns:
Type
Class.<Message>

accept() → {string}

Gets the request accept header

Source:
Returns:

This message object

Type
string

accept(accept) → {this}

Sets the request accept header

Parameters:
Name Type Description
accept string

the accept header value

Source:
Returns:

This message object

Type
this

acl() → {string}

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

Source:
Returns:

This message object

Type
string

acl(acl) → {this}

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

Parameters:
Name Type Description
acl Acl

the file ACLs

Source:
Returns:

This message object

Type
this

addQueryString(query) → {this}

Adds the given string to the request path

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

Parameters:
Name Type Description
query string | Object.<string, string>

which will added to the request path

Source:
Returns:
Type
this

cacheControl(value) → {this}

Sets the cache control header

Parameters:
Name Type Description
value string

The cache control flags

Source:
Returns:

This message object

Type
this

cacheControl() → {string}

Gets the cache control header

Source:
Returns:
Type
string

contentLength(contentLength) → {this}

Sets the contentLength

Parameters:
Name Type Description
contentLength number

the content length of the data

Source:
Returns:

This message object

Type
this

contentLength() → {number}

Gets the contentLength

Source:
Returns:
Type
number

customHeaders(customHeaders) → {this}

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

Parameters:
Name Type Description
customHeaders *

the file custom headers

Source:
Returns:

This message object

Type
this

customHeaders() → {string}

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

Source:
Returns:

This message object

Type
string

doReceive(response) → {void}

Handle the receive

Parameters:
Name Type Description
response Object

The received response headers and data

Source:
Returns:
Type
void

entity(data, typeopt) → {this}

Sets the entity type

Parameters:
Name Type Attributes Default Description
data *

The data to send

type EntityType <optional>
"json"

the type of the data one of 'json'|'text'|'blob'|'arraybuffer' defaults to 'json'

Source:
Returns:

This message object

Type
this

Gets the value of a the specified request header

Parameters:
Name Type Description
name string

The header name

Source:
Returns:

The header value

Type
string

Sets the value of a the specified request header

Parameters:
Name Type Description
name string

The header name

value string

The header value if omitted the value will be returned

Source:
Returns:

This message object

Type
this

ifMatch() → {string}

Gets the request conditional If-Match header

Source:
Returns:

This message object

Type
string

ifMatch(eTag) → {this}

Sets the request conditional If-Match header

Parameters:
Name Type Description
eTag string

the If-Match ETag value

Source:
Returns:

This message object

Type
this

ifNoneMatch() → {string}

Gets the request a ETag based conditional header

Source:
Returns:
Type
string

ifNoneMatch(eTag) → {this}

Sets the request a ETag based conditional header

Parameters:
Name Type Description
eTag string

The ETag value

Source:
Returns:

This message object

Type
this

ifUnmodifiedSince() → {string}

Gets the request date based conditional header

Source:
Returns:

This message object

Type
string

ifUnmodifiedSince(date) → {this}

Sets the request date based conditional header

Parameters:
Name Type Description
date Date

The date value

Source:
Returns:

This message object

Type
this

mimeType() → {string}

Get the mimeType

Source:
Returns:

This message object

Type
string

mimeType(mimeType) → {this}

Sets the mimeType

Parameters:
Name Type Description
mimeType string

the mimeType of the data

Source:
Returns:

This message object

Type
this

noCache() → {this}

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

Source:
Returns:
Type
this

progress() → {connector.Message~progressCallback}

Gets the progress callback

Source:
Returns:

The callback set

Type
connector.Message~progressCallback

progress(callback) → {this}

Sets the progress callback

Parameters:
Name Type Description
callback connector.Message~progressCallback
Source:
Returns:

This message object

Type
this

responseType() → {string}

Gets the response type which should be returned

Source:
Returns:

This message object

Type
string

responseType(type) → {this}

Sets the response type which should be returned

Parameters:
Name Type Description
type string

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

Source:
Returns:

This message object

Type
this

Type Definitions

progressCallback(event) → {*}

The progress callback is called, when you send a message to the server and a progress is noticed

Parameters:
Name Type Description
event ProgressEvent

The Progress Event

Source:
Returns:

unused

Type
*