Class MopHandler

Handler in charge of providing functionality related to the Mop (Method of Operation) module.

Inheritance

System.Object

BaseHandler

BaseFloARHandler

MopHandler

Inherited Members

BaseFloARHandler.GetDocumentDataFileName<T>(T)

BaseFloARHandler.GetDocumentDataFullPath<T, K>(T)

BaseFloARHandler.GetDocumentFullPath<T, K>(T)

BaseFloARHandler.SaveDocumentDataLocally<T, K>(T)

BaseFloARHandler.LoadDocumentLocalData<T, K>(T)

BaseFloARHandler.DoesDocumentExistsAndMatchesLocalVersion<T, K>(T)

BaseFloARHandler.LoadLocalDocumentOntoMemoryInDocumentContent<T, K>(T, Action<Byte[]>)

BaseFloARHandler.DeleteDocumentAndDocumentJsonData<T, K>(T)

BaseHandler.GetReusableApiRequest<T>()

BaseHandler.GetHandlerStoragePath<T>()

BaseHandler.JSON_FOLDER_NAME

BaseHandler.GetHandlerJsonFolderPath<K>()

BaseHandler.GetApiJsonFullPath<T, K>()

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile, Int32, String)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile, Int32, String)

BaseHandler.GetApiDownloadedBytesFullPath<T, K>(T, UserProfile, Int32, String)

BaseHandler.GetContentFromFileProcess(String, Action<Byte[]>, DataTransferStatus)

BaseHandler.SaveContentToFileProcess(Byte[], String, Action<Boolean>)

BaseHandler.DeleteFileProcess(String, Action<Boolean>)

BaseHandler.CopyFileToDestinationProcess(String, String, Action<Boolean>)

BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)

BaseHandler.GetChecksumFromExistingFile(String)

BaseHandler.ClearHandlerCache<T>(Action<Boolean>)

BaseHandler.TokenUsedForDownloads

BaseHandler.DownloadGenericFile(String, String, String, Boolean, Action<Byte[]>, DataTransferStatus)

BaseHandler.GetEmsContentFileSize(String, Action<Nullable<Int64>>)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Appearition.Mop

Assembly: Appearition.SDK.dll

Syntax

public class MopHandler : BaseFloARHandler

Methods

View Source

FetchAllMopDocumentInfo(MopSyncManifest, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given mop document content. Only the difference in content will be downloaded for a lightweight transfer. Consider storing that content locally for making full use of this system. In case of no connection, will simply load the existing data.

API Requirement: Session Token. Offline Capability.

Declaration

public static void FetchAllMopDocumentInfo(MopSyncManifest localMopData, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
MopSyncManifest	localMopData
System.Action<MopSyncManifest>	onSuccess	Contains the difference between the provided data and the data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

View Source

FetchAllMopDocumentInfo(MopSyncManifest, Boolean, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static void FetchAllMopDocumentInfo(MopSyncManifest localMopsData, bool downloadMopDocuments, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
MopSyncManifest	localMopsData
System.Boolean	downloadMopDocuments	Whether or not the Mop documents files should also be downloaded.
System.Action<MopSyncManifest>	onSuccess	Contains the difference between the provided data and the data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

View Source

FetchAllMopDocumentInfo(Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the mop document content from the EMS. If you have existing content, pass in a MopSyncManifest and the difference will be returned instead. In case of no connection, will simply load the existing data.

API Requirement: Session Token. Offline Capability.

Declaration

public static void FetchAllMopDocumentInfo(Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<MopSyncManifest>	onSuccess	Contains all the Mop data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

View Source

FetchAllMopDocumentInfo(Boolean, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static void FetchAllMopDocumentInfo(bool downloadMopDocuments, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadMopDocuments	Whether or not the Mop documents files should also be downloaded.
System.Action<MopSyncManifest>	onSuccess	Contains all the Mop data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

View Source

FetchAllMopDocumentInfoProcess(MopSyncManifest, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator FetchAllMopDocumentInfoProcess(MopSyncManifest localMopsData, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
MopSyncManifest	localMopsData
System.Action<MopSyncManifest>	onSuccess	Contains the difference between the provided data and the data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

View Source

FetchAllMopDocumentInfoProcess(MopSyncManifest, Boolean, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator FetchAllMopDocumentInfoProcess(MopSyncManifest localMopsData, bool downloadMopDocuments, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
MopSyncManifest	localMopsData
System.Boolean	downloadMopDocuments	Whether or not the Mop documents files should also be downloaded.
System.Action<MopSyncManifest>	onSuccess	Contains the difference between the provided data and the data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

View Source

FetchAllMopDocumentInfoProcess(Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator FetchAllMopDocumentInfoProcess(Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<MopSyncManifest>	onSuccess	Contains all the Mop data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

View Source

FetchAllMopDocumentInfoProcess(Boolean, Action<MopSyncManifest>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator FetchAllMopDocumentInfoProcess(bool downloadMopDocuments, Action<MopSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadMopDocuments	Whether or not the Mop documents files should also be downloaded.
System.Action<MopSyncManifest>	onSuccess	Contains all the Mop data on the EMS. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

View Source

FetchMopDocumentFile(Mop, Boolean, Action<Mop>, Action<EmsError>, Action<Boolean>)

Given document data, downloads the file if required, and loads the document into memory if required.

API Requirement: Session Token. Offline Capability.

Declaration

public static void FetchMopDocumentFile(Mop document, bool loadInMemory, Action<Mop> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Mop	document	The original MopDocument, which might not contain any runtime data.
System.Boolean	loadInMemory	Whether or not the file content is to be loaded in memory.
System.Action<Mop>	onSuccess	Contains the updated MopDocument. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

View Source

FetchMopDocumentFileProcess(Mop, Boolean, Action<Mop>, Action<EmsError>, Action<Boolean>)

Given document data, downloads the file if required, and loads the document into memory if required.

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator FetchMopDocumentFileProcess(Mop document, bool loadInMemory, Action<Mop> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Mop	document	The original MopDocument, which might not contain any runtime data.
System.Boolean	loadInMemory	Whether or not the file content is to be loaded in memory.
System.Action<Mop>	onSuccess	Contains the updated MopDocument. Only called if the request is successful.
System.Action<EmsError>	onFailure	Contains any error obtained during the request. Only called if the request has failed.
System.Action<System.Boolean>	onComplete	Always called at the end of the request, defines whether the request was successful or not.

Returns

Type	Description
System.Collections.IEnumerator

Extension Methods

ObjectExtension.ToStream(Object)