Flexberry Documentation Flexberry Documentation

  • API Docs for Version: master

    • APIs

    Show:

    Projection Class

    Module: ember-flexberry-data

    Methods

    attr

    (
    • caption
    • [options]
    )
    Object public

    Defined in addon/utils/attributes.js:8

    Define plain attribute in projection.

    Parameters:

    • caption String

      A user-friendly caption for attribute.

    • [options] Object optional

      Attribute options.

    Returns:

    Object:

    Projection attribute.

    belongsTo

    (
    • modelName
    • caption
    • attributes
    • [options]
    )
    Object public

    Defined in addon/utils/attributes.js:23

    Define belongsTo relationship attribute in projection.

    Parameters:

    • modelName String

      The name of the model type.

    • caption String

      A user-friendly caption for attribute.

    • attributes Object

      Projection attributes.

    • [options] Object optional

      Attribute options.

    Returns:

    Object:

    Projection attribute.

    create

    (
    • modelName
    • attributes
    • projectionName
    )
    Object public

    Defined in addon/utils/create.js:5

    Creates model projection.

    Parameters:

    • modelName String

      The name of the model type.

    • attributes Object

      Projection attributes.

    • projectionName String

      The name of the projection type.

    Returns:

    Object:

    Model projection.

    getBatchResponses

    (
    • response
    • boundary
    )
    String[]

    Defined in addon/utils/batch-queries.js:17

    Returns an array of batch responses from the body of the HTTP response.

    Parameters:

    • response String

      The body of the HTTP response.

    • boundary String

      The boundary.

    Returns:

    String[]:

    An array of batch responses.

    getResponseHeader

    (
    • header
    • response
    )
    String private

    Defined in addon/utils/batch-queries.js:150

    Parameters:

    • header String

      The header name.

    • response String

      The response from which will be extracted header.

    Returns:

    String:

    The content of the header.

    getResponseMeta

    (
    • contentTypeHeader
    )
    Object

    Defined in addon/utils/batch-queries.js:5

    Returns the type and boundary from the Content-Type header.

    Parameters:

    • contentTypeHeader String

      The content of Content-Type header.

    Returns:

    Object:

    Object with contentType and boundary properties.

    hasMany

    (
    • modelName
    • caption
    • attributes
    • [options]
    )
    Object public

    Defined in addon/utils/attributes.js:43

    Define hasMany relationship attribute in projection.

    Parameters:

    • modelName String

      The name of the model type.

    • caption String

      A user-friendly caption for attribute.

    • attributes Object

      Projection attributes.

    • [options] Object optional

      Attribute options.

    Returns:

    Object:

    Projection attribute.

    parseBatchResponse

    (
    • response
    )
    Object

    Defined in addon/utils/batch-queries.js:46

    Parses a batch response depending on its type.

    The returned object always contains the contentType property. Depending on the type of response it may contain the following additional properties:

    • response - for responses with application/http content type.
    • changesets - for responses with multipart/mixed content type.

    Parameters:

    • response String

      The batch response.

    Returns:

    Object:

    The object with the response description.

    parseResponse

    (
    • response
    )
    Object private

    Defined in addon/utils/batch-queries.js:89

    Parameters:

    • response String

      The string with the response content.

    Returns:

    Object:

    Object with meta and body properties.

    parseResponseMeta

    (
    • rawMeta
    )
    Object private

    Defined in addon/utils/batch-queries.js:131

    Parameters:

    • rawMeta String

      The string with the response metadata.

    Returns:

    Object:

    Object with status, statusText and contentType properties.

    parseСhangeset

    (
    • changeset
    )
    Object private

    Defined in addon/utils/batch-queries.js:76

    Parameters:

    • changeset String

      The string with the changeset content.

    Returns:

    Object:

    Object with contentID, meta and body properties.