Show / Hide Table of Contents

    Class JobHandler

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

    Inheritance
    System.Object
    BaseHandler
    BaseFloARHandler
    JobHandler
    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<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.Job
    Assembly: Appearition.SDK.dll
    Syntax
    public class JobHandler : BaseFloARHandler

    Methods

    FetchAllJobs(Action<UserSiteJob>, Action<EmsError>, Action<Boolean>)

    Fetches all the jobs available for the logged in user.

    API Requirement: Session Token. Offline Capability.

    Declaration
    public static void FetchAllJobs(Action<UserSiteJob> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Action<UserSiteJob> onSuccess

    Contains all the jobs available for this logged in user. 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.

    FetchAllJobsProcess(Action<UserSiteJob>, Action<EmsError>, Action<Boolean>)

    Declaration
    public static IEnumerator FetchAllJobsProcess(Action<UserSiteJob> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Action<UserSiteJob> onSuccess
    System.Action<EmsError> onFailure
    System.Action<System.Boolean> onComplete
    Returns
    Type Description
    System.Collections.IEnumerator

    FetchExistingJobFormData(UserProfile, Job, Action<JobPost>, Action<EmsError>, Action<Boolean>)

    Fetches the details of a previously posted job. Do note that only the user that posted it can access the job.

    API Requirement: Session Token.

    Declaration
    public static void FetchExistingJobFormData(UserProfile user, Job job, Action<JobPost> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    UserProfile user
    Job job
    System.Action<JobPost> onSuccess

    Contains the job previously posted. 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.

    FetchExistingJobFormData(Int64, Int64, Int64, Action<JobPost>, Action<EmsError>, Action<Boolean>)

    Fetches the details of a previously posted job. Do note that only the user that posted it can access the job.

    API Requirement: Session Token.

    Declaration
    public static void FetchExistingJobFormData(long userProfileId, long jobId, long siteId, Action<JobPost> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Int64 userProfileId
    System.Int64 jobId
    System.Int64 siteId
    System.Action<JobPost> onSuccess

    Contains the job previously posted. 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.

    FetchExistingJobFormDataProcess(UserProfile, Job, Action<JobPost>, Action<EmsError>, Action<Boolean>)

    Fetches the details of a previously posted job. Do note that only the user that posted it can access the job.

    API Requirement: Session Token.

    Declaration
    public static IEnumerator FetchExistingJobFormDataProcess(UserProfile user, Job job, Action<JobPost> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    UserProfile user
    Job job
    System.Action<JobPost> onSuccess

    Contains the job previously posted. 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

    FetchExistingJobFormDataProcess(Int64, Int64, Int64, Action<JobPost>, Action<EmsError>, Action<Boolean>)

    Fetches the details of a previously posted job. Do note that only the user that posted it can access the job.

    API Requirement: Session Token.

    Declaration
    public static IEnumerator FetchExistingJobFormDataProcess(long userProfileId, long jobId, long siteId, Action<JobPost> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    System.Int64 userProfileId
    System.Int64 jobId
    System.Int64 siteId
    System.Action<JobPost> onSuccess

    Contains the job previously posted. 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

    SubmitJobForm(JobPost, Action<Job>, Action<EmsError>, Action<Boolean>)

    Submits a job form completely. If any files are to be uploaded, it will also upload them while submitting.

    API Requirement: Session Token.

    Declaration
    public static void SubmitJobForm(JobPost mainJobPost, Action<Job> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    JobPost mainJobPost
    System.Action<Job> onSuccess

    Contains the updated state of the job that was just submitted. 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.

    SubmitJobForm(JobPost, List<JobFormFilePost>, Action<Job>, Action<EmsError>, Action<Boolean>)

    Submits a job form completely. If any files are to be uploaded, it will also upload them while submitting.

    API Requirement: Session Token.

    Declaration
    public static void SubmitJobForm(JobPost mainJobPost, List<JobFormFilePost> filesToUpload, Action<Job> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    JobPost mainJobPost
    System.Collections.Generic.List<JobFormFilePost> filesToUpload
    System.Action<Job> onSuccess

    Contains the updated state of the job that was just submitted. 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.

    SubmitJobFormProcess(JobPost, Action<Job>, Action<EmsError>, Action<Boolean>)

    Submits a job form completely. If any files are to be uploaded, it will also upload them while submitting.

    API Requirement: Session Token.

    Declaration
    public static IEnumerator SubmitJobFormProcess(JobPost mainJobPost, Action<Job> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    JobPost mainJobPost
    System.Action<Job> onSuccess

    Contains the updated state of the job that was just submitted. 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

    SubmitJobFormProcess(JobPost, List<JobFormFilePost>, Action<Job>, Action<EmsError>, Action<Boolean>)

    Submits a job form completely. If any files are to be uploaded, it will also upload them while submitting.

    API Requirement: Session Token.

    Declaration
    public static IEnumerator SubmitJobFormProcess(JobPost mainJobPost, List<JobFormFilePost> filesToUpload, Action<Job> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)
    Parameters
    Type Name Description
    JobPost mainJobPost
    System.Collections.Generic.List<JobFormFilePost> filesToUpload
    System.Action<Job> onSuccess

    Contains the updated state of the job that was just submitted. 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