Class SiteHandler

Handler in charge of providing functionality related to the Site module.

Inheritance

System.Object

BaseHandler

BaseFloARHandler

SiteHandler

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

Assembly: Appearition.SDK.dll

Syntax

public class SiteHandler : BaseFloARHandler

Methods

FetchAllSites(SiteSyncManifest, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given sites 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 FetchAllSites(SiteSyncManifest localSitesData, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
SiteSyncManifest	localSitesData
System.Action<SiteSyncManifest>	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.

FetchAllSites(SiteSyncManifest, Boolean, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given sites 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 FetchAllSites(SiteSyncManifest localSitesData, bool downloadSitesDocuments, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
SiteSyncManifest	localSitesData
System.Boolean	downloadSitesDocuments	Whether or not the sites documents should also be downloaded.
System.Action<SiteSyncManifest>	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.

FetchAllSites(Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

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

Parameters

Type	Name	Description
System.Action<SiteSyncManifest>	onSuccess	Contains all the Sites 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.

FetchAllSites(Boolean, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the sites content from the EMS. If you have existing content, pass in a SiteSyncManifest 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 FetchAllSites(bool downloadSitesDocuments, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadSitesDocuments	Whether or not the sites documents should also be downloaded.
System.Action<SiteSyncManifest>	onSuccess	Contains all the Sites 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.

FetchAllSitesProcess(SiteSyncManifest, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given sites 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 FetchAllSitesProcess(SiteSyncManifest localSitesData, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
SiteSyncManifest	localSitesData
System.Action<SiteSyncManifest>	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

FetchAllSitesProcess(SiteSyncManifest, Boolean, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Updates the given sites 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 FetchAllSitesProcess(SiteSyncManifest localSitesData, bool downloadSitesDocuments, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
SiteSyncManifest	localSitesData
System.Boolean	downloadSitesDocuments	Whether or not the sites documents should also be downloaded.
System.Action<SiteSyncManifest>	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

FetchAllSitesProcess(Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

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

Parameters

Type	Name	Description
System.Action<SiteSyncManifest>	onSuccess	Contains all the Sites 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

FetchAllSitesProcess(Boolean, Action<SiteSyncManifest>, Action<EmsError>, Action<Boolean>)

Fetches all the sites content from the EMS. If you have existing content, pass in a SiteSyncManifest 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 FetchAllSitesProcess(bool downloadSitesDocuments, Action<SiteSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadSitesDocuments	Whether or not the sites documents should also be downloaded.
System.Action<SiteSyncManifest>	onSuccess	Contains all the Sites 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

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

Parameters

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

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

Parameters

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