Home Reference Source Test
public class | source

ReadMessageBody

Extends:

RethinkObjectMessageBody → ReadMessageBody

Class representation of the ReadMessageBody data object

Constructor Summary

Public Constructor
public

constructor(idToken: Identity.JWT, accessToken: Identity.JWT, resource: URL.URL, schema: URL.HypertyCatalogueURL, assertedIdentity: Identity.Identity, attribute: String, criteriaSyntax: String, criteria: String)

Member Summary

Public Members
public
public
public

Inherited Summary

From class RethinkObject
public

validate(schema: *): boolean

Validates this RethinkObject against the provided schema.

From class MessageBody
public
public
public

idToken: *

public
public

schema: *

public

via: *

public

addVia(token: Identity.JWT): MessageBody

Adds a via URL to the given message body.

Public Constructors

public constructor(idToken: Identity.JWT, accessToken: Identity.JWT, resource: URL.URL, schema: URL.HypertyCatalogueURL, assertedIdentity: Identity.Identity, attribute: String, criteriaSyntax: String, criteria: String) source

Override:

MessageBody#constructor

Params:

NameTypeAttributeDescription
idToken Identity.JWT
accessToken Identity.JWT
resource URL.URL

URL of the objec

schema URL.HypertyCatalogueURL

URL of the Data object schema stored in the Catalogue

assertedIdentity Identity.Identity

AssertedIdentity is compliant with User Identity Data Model

attribute String

Identifies the attribute in the Object to be read (optional)

criteriaSyntax String

Defines the criteria syntax used in criteria field. To be used for search purposes. Valid criteria Syntax are: "key-value", "mongodb", "sql"(?), ...

criteria String

Defines the criteria to be used for search purposes. Syntax used to define the criteria is set in the criteriaSyntax.

Public Members

public attribute: * source

public criteria: * source

public criteriaSyntax: * source