Class ImageRecognitionHandler

Handles Image Recognition related API requests, which include getting and editing the Data Store entries. Those Data Store entries are related to the Image Recognition settings of external providers as on the EMS. When an Image Recognition is configured on the EMS, the future TargetImages will be synced with said provider.

Inheritance

System.Object

BaseHandler

ImageRecognitionHandler

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

Assembly: Appearition.SDK.dll

Syntax

public sealed class ImageRecognitionHandler : BaseHandler

Methods

GetAllAvailableProviders(Action<List<DataStore>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArProviders available for the selected channel.

API Requirement: Session Token. Offline Capability.

Declaration

public static void GetAllAvailableProviders(Action<List<DataStore>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<DataStore>>	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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.

GetAllAvailableProviders(Int32, Action<List<DataStore>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArProviders available for a given channel by ids.

API Requirement: Session Token. Offline Capability.

Declaration

public static void GetAllAvailableProviders(int channelId, Action<List<DataStore>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<DataStore>>	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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.

GetAllAvailableProvidersProcess(Action<List<DataStore>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArProviders available for the selected channel.

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator GetAllAvailableProvidersProcess(Action<List<DataStore>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<DataStore>>	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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

GetAllAvailableProvidersProcess(Int32, Action<List<DataStore>>, Action<EmsError>, Action<Boolean>)

Fetches all the ArProviders available for a given channel by ids.

API Requirement: Session Token. Offline Capability.

Declaration

public static IEnumerator GetAllAvailableProvidersProcess(int channelId, Action<List<DataStore>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<DataStore>>	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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

SetProviderData(DataStore, Action, Action<EmsError>, Action<Boolean>)

Creates or updates a ArProvider entry in the EMS using the given data. Do note that the provider name field will be used to match data with an existing entry.

API Requirement: Session Token.

Declaration

public static void SetProviderData(DataStore providerData, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
DataStore	providerData	ArProvider DataStore you wish to create or update.
System.Action	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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.

SetProviderData(Int32, DataStore, Action, Action<EmsError>, Action<Boolean>)

Creates or updates a ArProvider entry in the EMS using the given data. Do note that the provider name field will be used to match data with an existing entry.

API Requirement: Session Token.

Declaration

public static void SetProviderData(int channelId, DataStore providerData, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId
DataStore	providerData	ArProvider DataStore you wish to create or update.
System.Action	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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.

SetProviderDataProcess(DataStore, Action, Action<EmsError>, Action<Boolean>)

Creates or updates a ArProvider entry in the EMS using the given data. Do note that the provider name field will be used to match data with an existing entry.

API Requirement: Session Token.

Declaration

public static IEnumerator SetProviderDataProcess(DataStore providerData, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
DataStore	providerData	ArProvider DataStore you wish to create or update.
System.Action	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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

SetProviderDataProcess(Int32, DataStore, Action, Action<EmsError>, Action<Boolean>)

Creates or updates a ArProvider entry in the EMS using the given data. Do note that the provider name field will be used to match data with an existing entry.

API Requirement: Session Token.

Declaration

public static IEnumerator SetProviderDataProcess(int channelId, DataStore providerData, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
DataStore	providerData	ArProvider DataStore you wish to create or update.
System.Action	onSuccess	Contains all the ArProvider DataStores relevant to this channel. 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)