Class GeneralDocumentHandler

Handler in charge of providing functionality related to the General Documents module.

Inheritance

System.Object

BaseHandler

BaseFloARHandler

GeneralDocumentHandler

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.GeneralDocument

Assembly: Appearition.SDK.dll

Syntax

public class GeneralDocumentHandler : BaseFloARHandler

Methods

FetchAllGeneralDocumentInfo(GeneralSyncManifest, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given general doc info 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 FetchAllGeneralDocumentInfo(GeneralSyncManifest localDocumentInfoData, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
GeneralSyncManifest	localDocumentInfoData
System.Action<GeneralSyncManifest>	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.

FetchAllGeneralDocumentInfo(GeneralSyncManifest, Boolean, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given general doc info 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 FetchAllGeneralDocumentInfo(GeneralSyncManifest localDocumentInfoData, bool downloadGeneralDocuments, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
GeneralSyncManifest	localDocumentInfoData
System.Boolean	downloadGeneralDocuments	Whether or not the general documents files should also be downloaded.
System.Action<GeneralSyncManifest>	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.

FetchAllGeneralDocumentInfo(Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the general doc info content from the EMS. If you have existing content, pass in a GeneralSyncManifest 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 FetchAllGeneralDocumentInfo(Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<GeneralSyncManifest>	onSuccess	Contains all the general document 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.

FetchAllGeneralDocumentInfo(Boolean, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the general doc info content from the EMS. If you have existing content, pass in a GeneralSyncManifest 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 FetchAllGeneralDocumentInfo(bool downloadGeneralDocuments, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadGeneralDocuments	Whether or not the general documents files should also be downloaded.
System.Action<GeneralSyncManifest>	onSuccess	Contains all the general document 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.

FetchAllGeneralDocumentInfoProcess(GeneralSyncManifest, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given general doc info 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 IEnumerator FetchAllGeneralDocumentInfoProcess(GeneralSyncManifest localDocumentInfoData, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
GeneralSyncManifest	localDocumentInfoData
System.Action<GeneralSyncManifest>	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

FetchAllGeneralDocumentInfoProcess(GeneralSyncManifest, Boolean, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given general doc info 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 IEnumerator FetchAllGeneralDocumentInfoProcess(GeneralSyncManifest localDocumentInfoData, bool downloadGeneralDocuments, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
GeneralSyncManifest	localDocumentInfoData
System.Boolean	downloadGeneralDocuments	Whether or not the general documents files should also be downloaded.
System.Action<GeneralSyncManifest>	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

FetchAllGeneralDocumentInfoProcess(Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the general doc info content from the EMS. If you have existing content, pass in a GeneralSyncManifest 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 IEnumerator FetchAllGeneralDocumentInfoProcess(Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<GeneralSyncManifest>	onSuccess	Contains all the general document 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

FetchAllGeneralDocumentInfoProcess(Boolean, Action<GeneralSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the general doc info content from the EMS. If you have existing content, pass in a GeneralSyncManifest 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 IEnumerator FetchAllGeneralDocumentInfoProcess(bool downloadGeneralDocuments, Action<GeneralSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadGeneralDocuments	Whether or not the general documents files should also be downloaded.
System.Action<GeneralSyncManifest>	onSuccess	Contains all the general document 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

FetchGeneralDocumentFile(General, Boolean, Action<General>, 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 FetchGeneralDocumentFile(General document, bool loadInMemory, Action<General> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
General	document	The original General Doc, which might not contain any runtime data.
System.Boolean	loadInMemory	Whether or not the file content is to be loaded in memory.
System.Action<General>	onSuccess	Contains the updated General Doc. 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.

FetchGeneralDocumentFileProcess(General, Boolean, Action<General>, 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 FetchGeneralDocumentFileProcess(General document, bool loadInMemory, Action<General> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
General	document	The original General Doc, which might not contain any runtime data.
System.Boolean	loadInMemory	Whether or not the file content is to be loaded in memory.
System.Action<General>	onSuccess	Contains the updated General Doc. 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)