Namespace: Entities

Entities

Type Definitions

Asset

Properties:
Name Type Description
sys Entities.Sys Standard system metadata with additional entry specific properties
Properties
Name Type Attributes Description
locale string <optional>
 If present, indicates the locale which this asset uses
fields Object Object with content for each field
Properties
Name Type Description
title string Title for this asset
description string Description for this asset
file Object File object for this asset
Properties
Name Type Description
fileName Object Name for the file
contentType string Mime type for the file
url string Url where the file is available at.
details Object Details for the file, depending on file type (example: image size in bytes, etc)
toPlainObject() function Returns this Asset as a plain JS object
Source:

AssetCollection

Properties:
Name Type Description
total number
skip number
limit number
items Array.<Entities.Asset>
toPlainObject() function Returns this Asset collection as a plain JS object
Source:

ContentType

Properties:
Name Type Description
sys Entities.Sys System metadata
name string
description string
displayField string Field used as the main display field for Entries
Array string All the fields contained in this Content Type
toPlainObject() function Returns this Content Type as a plain JS object
Source:

ContentTypeCollection

Properties:
Name Type Description
total number
skip number
limit number
items Array.<Entities.ContentType>
toPlainObject() function Returns this Content Type collection as a plain JS object
Source:

Entry

Properties:
Name Type Description
sys Entities.Sys Standard system metadata with additional entry specific properties
Properties
Name Type Attributes Description
contentType Entities.Link Content Type used by this Entry
locale string <optional>
 If present, indicates the locale which this entry uses
fields Object.<EntryFields.Field> Object with content for each field
toPlainObject() function Returns this Entry as a plain JS object
Source:

EntryCollection

Properties:
Name Type Description
total number
skip number
limit number
items Array.<Entities.Entry>
toPlainObject() function Returns this Entry collection as a plain JS object
Source:

Field

A Field in an Entry can have one of the following types that can be defined in Contentful. See Field Types for more details.
Type:
EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Entities.Link | Array.<(EntryFields.Symbol|Entities.Link)> | Object
Source:
Link to another entity. See Links for more details.
Properties:
Name Type Description
type string type of this entity. Always link.
id string
linkType string type of this link. If defined, either Entry or Asset
Source:

Space

Properties:
Name Type Description
sys Object System metadata
Properties
Name Type Description
id string Space id
type string Entity type
name string Space name
locales Array.<string> Array with locale codes
toPlainObject() function Returns this Space as a plain JS object
Source:

Sys

System metadata. See Common Resource Attributes for more details.
Properties:
Name Type Description
type string
id string
space Entities.Link
createdAt string
updatedAt string
revision number
Source: