fields

Members

(static, constant) ALPHA_FIELD :DocumentField

A required numeric field which represents a uniform number between 0 and 1.

Type:

(static, constant) ANGLE_FIELD :DocumentField

A required numeric field which represents an angle of rotation in degrees between 0 and 360.

Type:

(static, constant) AUDIO_FIELD :DocumentField

A standard string field for an audio file path which may be used in a Document.

Type:

(static, constant) BLANK_STRING :DocumentField

A string field which is required, but may be left blank as an empty string.

Type:

(static, constant) BOOLEAN_FIELD :DocumentField

A required boolean field which may be used in a Document.

Type:

(static, constant) COLOR_FIELD :DocumentField

A standard string color field which may be used in a Document.

Type:

(static, constant) DOCUMENT_ID :DocumentField

The standard identifier for a Document.

Type:

(static, constant) DOCUMENT_PERMISSIONS :DocumentField

The standard permissions object which may be included by a Document.

Type:

(static, constant) IMAGE_FIELD :DocumentField

A standard string field for an image file path which may be used in a Document.

Type:

(static, constant) INTEGER_FIELD :DocumentField

A standard integer field which may be used in a Document.

Type:

(static, constant) INTEGER_SORT_FIELD :DocumentField

A field used for integer sorting of a Document relative to its siblings

Type:

(static, constant) JSON_FIELD :DocumentField

A string field which contains serialized JSON data that may be used in a Document.

Type:

(static, constant) NONNEGATIVE_INTEGER_FIELD :DocumentField

A non-negative integer field which may be used in a Document.

Type:

(static, constant) NUMERIC_FIELD :DocumentField

An optional numeric field which may be included in a Document.

Type:

(static, constant) OBJECT_FIELD :DocumentField

A template for a required inner-object field which may be used in a Document.

Type:

(static, constant) POSITIVE_INTEGER_FIELD :DocumentField

A non-negative integer field which may be used in a Document.

Type:

(static, constant) REQUIRED_NUMBER :DocumentField

A required numeric field which may be included in a Document and may not be null.

Type:

(static, constant) REQUIRED_POSITIVE_NUMBER :DocumentField

A required numeric field which must be a positive finite value that may be included in a Document.

Type:

(static, constant) REQUIRED_STRING :DocumentField

A string field which requires a non-blank value and may not be null.

Type:

(static, constant) STRING_FIELD :DocumentField

An optional string field which may be included by a Document.

Type:

(static, constant) TIMESTAMP_FIELD :DocumentField

A numeric timestamp field which may be used in a Document.

Type:

(static, constant) VIDEO_FIELD :DocumentField

A standard string field for a video or image file path may be used in a Document.

Type:

Methods

(static) embeddedCollectionField(document, optionsopt) → {DocumentField}

Create a special field which contains a Collection of embedded Documents

Parameters:
Name Type Attributes Default Description
document function

The Document class definition

options object <optional>
{}

Additional field options

Returns:
Type
DocumentField

(static) field() → {DocumentField}

Return a document field which is a modification of a static field type

Returns:
Type
DocumentField

(static) foreignDocumentField() → {DocumentField}

Create a foreign key field which references a primary Document id

Returns:
Type
DocumentField