Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Properties

Optional access

access: EntityAccess

The access privilege that the current user has for this entity.

Optional author

author: Author

The author of the document.

Optional changeId

changeId: string

The entity change identifier.

Optional content

Optional contentType

contentType: string

The content type of the document content.

Optional created

created: boolean

Whether or not this entity represents a created item.

Optional culture

culture: string

The culture of the entity.

Optional deleted

deleted: boolean

Whether or not this entity represents a deleted item.

Optional description

description: string

The description of the entity.

Optional editor

editor: Author

The editor of the document.

Optional entityChunkSize

entityChunkSize: number

The length of the content chunks.

Optional entityId

entityId: string

The entity identifier.

Optional entityLength

entityLength: number

The length of the content entity.

Optional expires

expires: boolean

Whether or not this entity represents an item that expires.

Optional expiryId

expiryId: string

The entity expiry identifier.

Optional fileType

fileType: string

The file type of the document.

Optional globalId

globalId: string

The entity global identifier.

Optional grants

grants: Grant[]

The list of grants which determine which users or groups have access privilege to this entity.

Optional id

id: string

The the ID of the document. This is set by the server on creation.

Optional issuerTitle

issuerTitle: string

The issuer title of the entity.

Optional properties

properties: PropertySet

The custom properties of the entity.

Optional shape

shape: Shape

The shapes of the entity.

Optional tags

tags: string[]

The tags for the document. Tags should be unique.

Optional thumbnail

thumbnail: Thumbnail

The thumbnail image of the entity.

Optional timeOfCreation

timeOfCreation: Date

The date the document was created. This value is managed by the server.

Optional timeOfDeletion

timeOfDeletion: Date

The date the document will delete. The value is managed by the client but the expiration is implemented by the server.

Optional timeOfExpiration

timeOfExpiration: Date

The date the document will expire. The value is managed by the client but the expiration is implemented by the server.

Optional timeOfLastAccess

timeOfLastAccess: Date

The date the document was last accessed. This value is managed by the server.

Optional timeOfLastModification

timeOfLastModification: Date

The date the document was last modified. This value is managed by the server.

Optional title

title: string

The title of the document. This is non-unique and user-defined.

Optional updates

updates: string[]

The list of fields to update when updating the entity. Otherwise all fields will be updated.

Optional version

version: string

The version of the entity.

Functions

diff

  • Compare the two offline maps and return an object containing only the values that are different in offlineMapB.

    Parameters

    • offlineMapA: OfflineMap

      The offline map to compare from.

    • offlineMapB: OfflineMap

      The offline map to compare to, where differing values will come from.

    Returns OfflineMap

    An offline map-like object containing only the differences.

verify

  • Perform basic verification on the OfflineMap. Throws errors if the OfflineMap is malformed.

    Parameters

    • offlineMap: OfflineMap

      The OfflineMap to verify.

    Returns void