Namespace: Mop

Namespaces

Document

Methods

Appearition.Mop.GetDocument (mopDocumentId, requestOptions)object static

Retrieves the contents of a specific submitted file

Name	Type	Description
mopDocumentId	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.Mop.GetMopSyncManifest (request, requestOptions)Appearition.Mop.MopSyncManifestViewModel static

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

Name	Type	Description
request	Appearition.Mop.MopSyncManifestViewModel	Contains the identifiers for retrieving the required records
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
Appearition.Mop.MopSyncManifestViewModel	This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.Mop.MopDocSyncManifestViewModel

Represents a Mop document and all of the details

Properties:

Name	Type	Description
DocumentId	number	The unique identifier for the Mop Document
ShelterType	Appearition.Site.ShelterTypeEnum	The numerical value of the Appearition.Site.ShelterTypeEnum. This is a mandatory property
MainsHybridGenset	Appearition.Site.MainsHybridGensetEnum	The numerical value of the Appearition.Site.MainsHybridGensetEnum.
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 Mop 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.Mop.MopSyncManifestViewModel

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

Properties:

Name	Type	Description
Mops	Array.<Appearition.Mop.MopDocSyncManifestViewModel>	A collection of Mop document records