Class BaseFloARHandler

Base class for a FloAR-like handler. Contains utilities to deal with handlers of that generation.

Inheritance

System.Object

BaseHandler

BaseFloARHandler

GeneralDocumentHandler

JobHandler

MopHandler

PartHandler

SiteHandler

Inherited Members

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

Assembly: Appearition.SDK.dll

Syntax

public class BaseFloARHandler : BaseHandler

Methods

DeleteDocumentAndDocumentJsonData<T, K>(T)

Deletes both the document file and the document data json, if they exist.

Declaration

protected static IEnumerator DeleteDocumentAndDocumentJsonData<T, K>(T document)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	document	Document data

Returns

Type	Description
System.Collections.IEnumerator

Type Parameters

Name	Description
T	Document Type
K	Handler class

DoesDocumentExistsAndMatchesLocalVersion<T, K>(T)

Whether or not this document was previously downloaded and exists locally.

Declaration

protected static bool DoesDocumentExistsAndMatchesLocalVersion<T, K>(T document)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	document	Document Data

Returns

Type	Description
System.Boolean	Whether or not a local version of the document exists and has a matching version.

Type Parameters

Name	Description
T	Document Type
K	Handler class

GetDocumentDataFileName<T>(T)

Using a given Document Data, generates a filename that will be used for the json data stored locally.

Declaration

protected static string GetDocumentDataFileName<T>(T document)
    where T : BaseDocument

Parameters

Type	Name	Description
T	document

Returns

Type	Description
System.String	The filename of the data of a given document.

Type Parameters

Name	Description
T	The type of document.

GetDocumentDataFullPath<T, K>(T)

Returns the expected full path to the data file of a given document.

Declaration

public static string GetDocumentDataFullPath<T, K>(T document)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	document	The document content.

Returns

Type	Description
System.String	The expected full path to the data file of a given document.

Type Parameters

Name	Description
T	The type of document.
K	The type of handler

GetDocumentFullPath<T, K>(T)

Returns the expected full path to a given document.

Declaration

public static string GetDocumentFullPath<T, K>(T document)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	document	The document content.

Returns

Type	Description
System.String	The expected full path to the given document.

Type Parameters

Name	Description
T	The type of document.
K	The type of handler

LoadDocumentLocalData<T, K>(T)

Using a given Document Data object, loads the existing matching Document Data, if any.

Declaration

protected static T LoadDocumentLocalData<T, K>(T documentData)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	documentData	Document Data

Returns

Type	Description
T

Type Parameters

Name	Description
T	Document Type
K	Handler class

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

Loads the content of a document into memory, located inside the document object which will be updated. In case of failure, will return false.

Declaration

protected static IEnumerator LoadLocalDocumentOntoMemoryInDocumentContent<T, K>(T document, Action<byte[]> onComplete = null)
    where T : BaseDocument where K : BaseFloARHandler

Parameters

Type	Name	Description
T	document	Original document
System.Action<System.Byte[]>	onComplete

Returns

Type	Description
System.Collections.IEnumerator

Type Parameters

Name	Description
T
K

SaveDocumentDataLocally<T, K>(T)

Saves the data of a specific document locally for offline usage and download efficiency purpose.

Declaration

protected static void SaveDocumentDataLocally<T, K>(T documentData)
    where T : BaseDocument, new()
    where K : BaseFloARHandler

Parameters

Type	Name	Description
T	documentData

Type Parameters

Name	Description
T	Document Type
K	Handler class

Extension Methods

ObjectExtension.ToStream(Object)