Show / Hide Table of Contents

    Class FormHandler

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

    Inheritance
    System.Object
    BaseHandler
    FormHandler
    Inherited Members
    BaseHandler.GetReusableApiRequest<T>()
    BaseHandler.GetHandlerStoragePath<T>()
    BaseHandler.JSON_FOLDER_NAME
    BaseHandler.GetHandlerJsonFolderPath<T>()
    BaseHandler.GetApiJsonFileName<T>()
    BaseHandler.GetApiJsonFileName<T>(UserProfile)
    BaseHandler.GetApiJsonFileFullPath<T, K>(UserProfile)
    BaseHandler.EncryptData(String)
    BaseHandler.DecryptData(String)
    BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>)
    BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>, UserProfile)
    BaseHandler.SaveJsonData<T, K>(AppearitionRequest<T>, String)
    BaseHandler.SaveJsonData<K>(String, String)
    BaseHandler.TryToFetchOfflineRequestContent<T, K>()
    BaseHandler.TryToFetchOfflineRequestContent<T, K>(UserProfile)
    BaseHandler.TryToFetchOfflineRequestContent<T, K>(String)
    BaseHandler.LoadJsonTextInFile<K>(String)
    BaseHandler.GetContentFromFileProcess(String, Action<Byte[]>)
    BaseHandler.SaveContentToFileProcess(Byte[], String, Action<Boolean>)
    BaseHandler.DeleteFileProcess(String, Action<Boolean>)
    BaseHandler.CopyFileToDestinationProcess(String, String, Action<Boolean>)
    BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)
    BaseHandler.DownloadGenericFile(String, String, String, Boolean, Action<Byte[]>)
    BaseHandler.HandleSimpleOfflineApiContentLoadingWithCallback<T, K>(Action<T>, Action<EmsError>, Action<Boolean>)
    BaseHandler.HandleSimpleOnlineOnlyApiInternetCheck(Action<Boolean>, Action<EmsError>, Action<Boolean>)
    Namespace: Appearition.Form
    Assembly: Appearition.SDK.dll
    Syntax
    public sealed class FormHandler : BaseHandler

    Methods

    FetchAllForms(FormSyncManifest, Action<FormSyncManifest>, Action<EmsError>, Action<Boolean>)

    Updates the given form 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 FetchAllForms(FormSyncManifest localFormData, Action<FormSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    FormSyncManifest localFormData
    System.Action<FormSyncManifest> 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.

    FetchAllForms(Action<FormSyncManifest>, Action<EmsError>, Action<Boolean>)

    Fetches all the form content from the EMS. If you have existing content, pass in a FormSyncManifest 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 FetchAllForms(Action<FormSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Action<FormSyncManifest> 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.

    FetchAllFormsProcess(FormSyncManifest, Action<FormSyncManifest>, Action<EmsError>, Action<Boolean>)

    Updates the given form 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 FetchAllFormsProcess(FormSyncManifest localFormData, Action<FormSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    FormSyncManifest localFormData
    System.Action<FormSyncManifest> 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

    FetchAllFormsProcess(Action<FormSyncManifest>, Action<EmsError>, Action<Boolean>)

    Fetches all the form content from the EMS. If you have existing content, pass in a FormSyncManifest 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 FetchAllFormsProcess(Action<FormSyncManifest> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Action<FormSyncManifest> 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

    Extension Methods

    ObjectExtension.ToStream(Object)
    Back to top Appearition SDK for Unity API