Appearition Platform JS

Namespace: GeneralDocument

Appearition.GeneralDocument

Use the functions under this module to access General documents on the Appearition platform

Namespaces

Manage

Methods

Appearition.GeneralDocument.GetDocument (generalDocumentId, requestOptions)object static

Retrieves the contents of a specific submitted file

Name Type Description
generalDocumentId number

The unique identifier of the document
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
object File stream

Appearition.GeneralDocument.GetGeneralDocumentSyncManifest (request, requestOptions)Appearition.GeneralDocument.GeneralSyncManifestViewModel static

Retrieves a delta of modified General Documents on the server. The delta is determined from the view model sent in the request body Will return the Appearition.GeneralDocument.GeneralSyncManifestViewModel model

Name Type Description
request Appearition.GeneralDocument.GeneralSyncManifestViewModel

Contains the identifiers for retrieving the required records
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
Appearition.GeneralDocument.GeneralSyncManifestViewModel This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.GeneralDocument.GeneralDocSyncManifestViewModel

Represents a GeneralDocument document and all of the details

Properties:
Name Type Description
DocumentId number

The unique identifier for the GeneralDocument Document
FormKey string

Unique identifies the Form
VersionNo number

Identifies the specific version of this document
DocumentName string

The title given to the document. Note this will differ to the File Name
DateModified string

The date/time as UTC, that this document was last changed.
FileName string

The name of the file
IsActive boolean

During the GeneralDocument sync process, if the client posted a document which is not longer available on the server, then this field will be set to false and the client should immediately remove the document from any local cache

Appearition.GeneralDocument.GeneralSyncManifestViewModel

This data structure holds the details of all General Documents synchronised from server to client

Properties:
Name Type Description
GeneralDocs Array.<Appearition.GeneralDocument.GeneralDocSyncManifestViewModel>

A collection of GeneralDocument document records