Class ArTargetHandler

Handler in charge of taking care of any ArTarget, Media and TargetImage related operations. Offers an easy to use access to the CRUD features for those operations.

Inheritance

System.Object

BaseHandler

ArTargetHandler

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

Assembly: Appearition.SDK.dll

Syntax

public class ArTargetHandler : BaseHandler

Methods

AddMediaToExistingExperience(Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int arTargetId, MediaFile data, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, MediaFile, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Once complete, you can choose to publish this experience, making it visible when using any Asset processes. If the experience was already published, there is no need to publish it again.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int arTargetId, MediaFile data, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, MediaFile, Object, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Optionally, a file can be uploaded and attached to this media.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int arTargetId, MediaFile data, object mediaToUpload, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Optionally, a file can be uploaded and attached to this media. Once complete, you can choose to publish this experience, making it visible when using any Asset processes. If the experience was already published, there is no need to publish it again.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int arTargetId, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int channelId, int arTargetId, MediaFile data, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, Int32, MediaFile, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int channelId, int arTargetId, MediaFile data, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, Int32, MediaFile, Object, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Optionally, a file can be uploaded and attached to this media.

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int channelId, int arTargetId, MediaFile data, object mediaToUpload, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperience(Int32, Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void AddMediaToExistingExperience(int channelId, int arTargetId, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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.

AddMediaToExistingExperienceProcess(Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId.

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int arTargetId, MediaFile data, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, MediaFile, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int arTargetId, MediaFile data, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, MediaFile, Object, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Optionally, a file can be uploaded and attached to this media.

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int arTargetId, MediaFile data, object mediaToUpload, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int arTargetId, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId.

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int channelId, int arTargetId, MediaFile data, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, Int32, MediaFile, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int channelId, int arTargetId, MediaFile data, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, Int32, MediaFile, Object, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Adds a new Media to the experience of a given ArTargetId. Optionally, a file can be uploaded and attached to this media.

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int channelId, int arTargetId, MediaFile data, object mediaToUpload, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

AddMediaToExistingExperienceProcess(Int32, Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(int channelId, int arTargetId, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Object	mediaToUpload	Media object to upload and attach to the MediaFile.
System.Boolean	publishOnComplete	Whether the experience should be published once the media has been successfully uploaded.
System.Action<MediaFile>	onSuccess	Contains the MediaFile object freshly synced with the cloud. 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

ChangeExperienceName(Int32, Int32, String, Action, Action<EmsError>, Action<Boolean>)

Changes the name of the experience as displayed on the EMS. Simply requires the ArTargetId and the new name in order to work. Callbacks can be provided as well.

API Requirement: Session Token.

Declaration

public static void ChangeExperienceName(int channelId, int arTargetId, string newName, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to rename.
System.String	newName	New name for the Experience.
System.Action	onSuccess	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.

ChangeExperienceName(Int32, String, Action, Action<EmsError>, Action<Boolean>)

Changes the name of the experience as displayed on the EMS. Simply requires the ArTargetId and the new name in order to work. Callbacks can be provided as well.

API Requirement: Session Token.

Declaration

public static void ChangeExperienceName(int arTargetId, string newName, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to rename.
System.String	newName	New name for the Experience.
System.Action	onSuccess	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.

ChangeExperienceNameProcess(Int32, Int32, String, Action, Action<EmsError>, Action<Boolean>)

Changes the name of the experience as displayed on the EMS. Simply requires the ArTargetId and the new name in order to work. Callbacks can be provided as well.

API Requirement: Session Token.

Declaration

public static IEnumerator ChangeExperienceNameProcess(int channelId, int arTargetId, string newName, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to rename.
System.String	newName	New name for the Experience.
System.Action	onSuccess	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

ChangeExperienceNameProcess(Int32, String, Action, Action<EmsError>, Action<Boolean>)

Changes the name of the experience as displayed on the EMS. Simply requires the ArTargetId and the new name in order to work. Callbacks can be provided as well.

API Requirement: Session Token.

Declaration

public static IEnumerator ChangeExperienceNameProcess(int arTargetId, string newName, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to rename.
System.String	newName	New name for the Experience.
System.Action	onSuccess	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

ClearLocalAssetContent<T>(T, Boolean, Boolean, Action<Boolean>)

Deletes the cached content of an asset based on given parameters.

Declaration

public static void ClearLocalAssetContent<T>(T asset, bool deleteTargetImages, bool deleteMediaFiles, Action<bool> onComplete)
    where T : Asset

Parameters

Type	Name	Description
T	asset	The given asset.
System.Boolean	deleteTargetImages	Whether or not the target images are to be deleted.
System.Boolean	deleteMediaFiles	Whether or not the MediaFile content are to be deleted.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not this process has been successfully completed.

Type Parameters

Name	Description
T	The type of asset.

ClearLocalAssetContentProcess<T>(T, Boolean, Boolean, Action<Boolean>)

Clears the cached content of an asset based on given parameters.

Declaration

public static IEnumerator ClearLocalAssetContentProcess<T>(T asset, bool clearTargetImages, bool clearMediaFiles, Action<bool> onComplete)
    where T : Asset

Parameters

Type	Name	Description
T	asset	The given asset.
System.Boolean	clearTargetImages	Whether or not the target images are to be removed from local storage.
System.Boolean	clearMediaFiles	Whether or not the MediaFile content are to be removed from local storage.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not this process has been successfully completed.

Returns

Type	Description
System.Collections.IEnumerator

Type Parameters

Name	Description
T	The type of asset.

ClearLocalMediaFileContent(Asset, MediaFile, Action<Boolean>)

Deletes the cached files of a given MediaFile.

Declaration

public static void ClearLocalMediaFileContent(Asset asset, MediaFile mediaFile, Action<bool> onComplete)

Parameters

Type	Name	Description
Asset	asset	The asset which contains the given Mediafile.
MediaFile	mediaFile	The MediaFile you wish to delete.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not this process has been successfully completed.

ClearLocalMediaFileContentProcess(Asset, MediaFile, Action<Boolean>)

Deletes the cached files of a given MediaFile.

Declaration

public static IEnumerator ClearLocalMediaFileContentProcess(Asset asset, MediaFile mediaFile, Action<bool> onComplete)

Parameters

Type	Name	Description
Asset	asset	The asset which contains the given Mediafile.
MediaFile	mediaFile	The MediaFile you wish to delete.
System.Action<System.Boolean>	onComplete	Occurs when the process is completed. Contains whether or not this process has been successfully completed.

Returns

Type	Description
System.Collections.IEnumerator

CreateExperience(Int32, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and a given channel id.

API Requirement: Session Token.

Declaration

public static void CreateExperience(int channelId, string experienceName, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(Int32, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and a given channel id, using provided experience name, targetImage and filename. Optionally, this experience can be published once created. This will make it visible to Asset processes.

API Requirement: Session Token.

Declaration

public static void CreateExperience(int channelId, string experienceName, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(Int32, String, Texture, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and a given channel id, using provided experience name, targetImage and filename. By default, this experience will be published once created, making it available to Asset processes.

API Requirement: Session Token.

Declaration

public static void CreateExperience(int channelId, string experienceName, Texture newTargetImage, string filename, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(Int32, String, Texture, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void CreateExperience(int channelId, string experienceName, Texture newTargetImage, string filename, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and channel.

API Requirement: Session Token.

Declaration

public static void CreateExperience(string experienceName, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void CreateExperience(string experienceName, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(String, Texture, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and channel, using provided experience name, targetImage and filename. By default, this experience will be published once created, making it available to Asset processes.

API Requirement: Session Token.

Declaration

public static void CreateExperience(string experienceName, Texture newTargetImage, string filename, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperience(String, Texture, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void CreateExperience(string experienceName, Texture newTargetImage, string filename, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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.

CreateExperienceProcess(Int32, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and a given channel id.

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(int channelId, string experienceName, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(Int32, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(int channelId, string experienceName, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(Int32, String, Texture, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(int channelId, string experienceName, Texture newTargetImage, string filename, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(Int32, String, Texture, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(int channelId, string experienceName, Texture newTargetImage, string filename, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Create a new experience in the current user's tenant and channel.

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(string experienceName, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(string experienceName, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(String, Texture, String, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(string experienceName, Texture newTargetImage, string filename, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

CreateExperienceProcess(String, Texture, String, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator CreateExperienceProcess(string experienceName, Texture newTargetImage, string filename, bool publishExperience, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	experienceName	The name of the experience you wish to create.
UnityEngine.Texture	newTargetImage	The TargetImage of the ArTarget being created.
System.String	filename	The name of the TargetImage being uploaded.
System.Boolean	publishExperience	Whether or not this experience should be published once created.
System.Action<ArTarget>	onSuccess	Contains the ArTarget object freshly created and synced with the cloud. 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

GetChannelArTargets(Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

Fetches all the ArTargets from the channel and tenant entered in the current user. Do note that this request requires the user to be logged in.

API Requirement: Session Token. Offline capability.

Declaration

public static void GetChannelArTargets(Action<ArTarget[]> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets from the selected 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.

GetChannelArTargets(Boolean, Boolean, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

Fetches all the ArTargets from the channel and tenant entered in the current user. Do note that this request requires the user to be logged in. Variant allowing a file name for the request to be saved for offline handling. Variant also allowing to download the target images, the MediaFile's content, or both.

API Requirement: Session Token. Offline capability.

Declaration

public static void GetChannelArTargets(bool downloadTargetImages, bool downloadContent, Action<ArTarget[]> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets from the selected 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.

GetChannelArTargets(Int32, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

Fetches all the ArTargets from the channel and tenant entered in the given user. Do note that this request requires the user to be logged in. Variant allowing a file name for the request to be saved for offline handling.

API Requirement: Session Token. Offline capability.

Declaration

public static void GetChannelArTargets(int channelId, Action<ArTarget[]> 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<ArTarget[]>	onSuccess	Contains all the ArTargets the channel of the given id. 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.

GetChannelArTargets(Int32, Boolean, Boolean, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline capability.

Declaration

public static void GetChannelArTargets(int channelId, bool downloadTargetImages, bool downloadContent, Action<ArTarget[]> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets the channel of the given id. 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.

GetChannelArTargetsProcess(Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

Fetches all the ArTargets from the channel and tenant entered in the current user. Do note that this request requires the user to be logged in.

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(Action<ArTarget[]> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets from the selected 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

GetChannelArTargetsProcess(Boolean, Boolean, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(bool downloadTargetImages, bool downloadContent, Action<ArTarget[]> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets from the selected 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

GetChannelArTargetsProcess(Int32, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(int channelId, Action<ArTarget[]> 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<ArTarget[]>	onSuccess	Contains all the ArTargets the channel of the given id. 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

GetChannelArTargetsProcess(Int32, Boolean, Boolean, Action<ArTarget[]>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token. Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(int channelId, bool downloadTargetImages, bool downloadContent, Action<ArTarget[]> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget[]>	onSuccess	Contains all the ArTargets the channel of the given id. 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

GetChannelExperiences(Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

Fetches all the experiences from the channel sorted inside the given user ApiData. Returns them as a callback whenever they're ready.

API Requirement: Anonymous Token. Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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.

GetChannelExperiences(Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

Fetches all the experiences from the channel sorted inside the given user ApiData. Returns them as a callback whenever they're ready. A filename can be provided for the system to store the request's content locally, enabling an offline capability. Each type of ApiData can also be chose to be downloaded locally.

API Requirement: Anonymous Token. Offline capability.

Declaration

public static void GetChannelExperiences(bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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.

GetChannelExperiences(List<Asset>, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

Fetches all the experiences from the channel sorted inside the given user ApiData. A filename can be provided for the system to store the request's content locally, enabling an offline capability. Each type of ApiData can also be chose to be downloaded locally.

API Requirement: Anonymous Token. Offline capability.

Declaration

public static void GetChannelExperiences(List<Asset> reusableList, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<Asset>	reusableList	Reusable list of assets.
System.Boolean	downloadTargetImages	If set to `true` download target images.
System.Boolean	downloadContent	If set to `true` download content.
System.Boolean	downloadPreDownloads	If set to `true` download pre downloads.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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.

GetChannelExperiences(Int32, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

Fetches all the experiences from the channel of the given id. A filename can be provided for the system to store the request's content locally, enabling an offline capability. Each type of ApiData can also be chose to be downloaded locally.

API Requirement: Anonymous Token. Offline capability.

Declaration

public static void GetChannelExperiences(int channelId, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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.

GetChannelExperiences(Int32, List<Asset>, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

API Requirement: Anonymous Token. Offline capability.

Declaration

public static void GetChannelExperiences(int channelId, List<Asset> reusableList, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<Asset>	reusableList	Reusable list of assets.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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.

GetChannelExperiencesProcess(Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

Fetches all the experiences from the channel sorted inside the given user ApiData. Returns them as a callback whenever they're ready.

API Requirement: Anonymous Token. Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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

GetChannelExperiencesProcess(Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

API Requirement: Anonymous Token. Offline capability.

Declaration

public static IEnumerator GetChannelExperiencesProcess(bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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

GetChannelExperiencesProcess(List<Asset>, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

API Requirement: Anonymous Token. Offline capability.

Declaration

public static IEnumerator GetChannelExperiencesProcess(List<Asset> reusableList, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Collections.Generic.List<Asset>	reusableList	Reusable list of assets.
System.Boolean	downloadTargetImages	If set to `true` download target images.
System.Boolean	downloadContent	If set to `true` download content.
System.Boolean	downloadPreDownloads	If set to `true` download pre downloads.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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

GetChannelExperiencesProcess(Int32, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

API Requirement: Anonymous Token. Offline capability.

Declaration

public static IEnumerator GetChannelExperiencesProcess(int channelId, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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

GetChannelExperiencesProcess(Int32, List<Asset>, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>)

API Requirement: Anonymous Token. Offline capability.

Declaration

public static IEnumerator GetChannelExperiencesProcess(int channelId, List<Asset> reusableList, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.List<Asset>	reusableList	Reusable list of assets.
System.Boolean	downloadTargetImages	Whether or not the Target Images should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadPreDownloads	Whether or not the Medias marked as pre-download should be downloaded. If downloadContent is set to true, the medias will get downloaded anyway.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Asset ApiData stored in the selected. 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

GetPathToAssetDirectory(Asset)

Path to an Asset (or any data extending Asset).

Declaration

public static string GetPathToAssetDirectory(Asset asset)

Parameters

Type	Name	Description
Asset	asset

Returns

Type	Description
System.String

GetPathToMedia(Asset, MediaFile)

Path to a Media file.

Declaration

public static string GetPathToMedia(Asset asset, MediaFile media)

Parameters

Type	Name	Description
Asset	asset
MediaFile	media

Returns

Type	Description
System.String

GetPathToMediaDirectory(Asset, MediaFile)

Path to the Media directory (or any data extending MediaFile), usually contained inside Asset directory.

Declaration

public static string GetPathToMediaDirectory(Asset asset, MediaFile media)

Parameters

Type	Name	Description
Asset	asset
MediaFile	media

Returns

Type	Description
System.String

GetPathToTargetImage(Asset, TargetImage)

Path to a Target Image file.

Declaration

public static string GetPathToTargetImage(Asset asset, TargetImage targetImage)

Parameters

Type	Name	Description
Asset	asset
TargetImage	targetImage

Returns

Type	Description
System.String

GetPathToTargetImageDirectory(Asset, TargetImage)

Path to a TargetImage (or any data extending TargetImage), usually contained inside Assets.

Declaration

public static string GetPathToTargetImageDirectory(Asset asset, TargetImage target)

Parameters

Type	Name	Description
Asset	asset
TargetImage	target

Returns

Type	Description
System.String

GetSingleArTarget(Int32, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static void GetSingleArTarget(int arTargetId, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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.

GetSingleArTarget(Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static void GetSingleArTarget(int arTargetId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Boolean	downloadTargetImages	Whether or not the Target Image should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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.

GetSingleArTarget(Int32, Int32, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static void GetSingleArTarget(int arTargetId, int channelId, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Int32	channelId	The id of the targeted channel.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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.

GetSingleArTarget(Int32, Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static void GetSingleArTarget(int arTargetId, int channelId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Image should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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.

GetSingleArTargetProcess(Int32, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static IEnumerator GetSingleArTargetProcess(int arTargetId, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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

GetSingleArTargetProcess(Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static IEnumerator GetSingleArTargetProcess(int arTargetId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Boolean	downloadTargetImages	Whether or not the Target Image should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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

GetSingleArTargetProcess(Int32, Int32, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static IEnumerator GetSingleArTargetProcess(int arTargetId, int channelId, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Int32	channelId	The id of the targeted channel.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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

GetSingleArTargetProcess(Int32, Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Fetches a single ArTarget from the EMS, using a given ArTargetId. Do note that this request requires the user to be logged in.

API Requirement: Session Token. ///

Declaration

public static IEnumerator GetSingleArTargetProcess(int arTargetId, int channelId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	arTargetId	The Id of the desired ArTarget.
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadTargetImages	Whether or not the Target Image should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Boolean	downloadContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Action<ArTarget>	onSuccess	Contains the ArTarget of a given ArTargetId, if found in the given 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

GetSpecificMediasForAGivenAsset(String, Boolean, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static void GetSpecificMediasForAGivenAsset(string assetId, bool downloadAllContent, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Boolean	downloadAllContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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.

GetSpecificMediasForAGivenAsset(String, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static void GetSpecificMediasForAGivenAsset(string assetId, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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.

GetSpecificMediasForAGivenAsset(String, Int32, Boolean, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static void GetSpecificMediasForAGivenAsset(string assetId, int channelId, bool downloadAllContent, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadAllContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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.

GetSpecificMediasForAGivenAsset(String, Int32, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static void GetSpecificMediasForAGivenAsset(string assetId, int channelId, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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.

GetSpecificMediasForAGivenAssetProcess(String, Boolean, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static IEnumerator GetSpecificMediasForAGivenAssetProcess(string assetId, bool downloadAllContent, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Boolean	downloadAllContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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

GetSpecificMediasForAGivenAssetProcess(String, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static IEnumerator GetSpecificMediasForAGivenAssetProcess(string assetId, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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

GetSpecificMediasForAGivenAssetProcess(String, Int32, Boolean, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static IEnumerator GetSpecificMediasForAGivenAssetProcess(string assetId, int channelId, bool downloadAllContent, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Int32	channelId	The id of the targeted channel.
System.Boolean	downloadAllContent	Whether or not the Medias should be downloaded. Do note that the EMS needs to allow this feature as well.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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

GetSpecificMediasForAGivenAssetProcess(String, Int32, Dictionary<String, String>, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>)

Fetches all the Medias from an asset of a given Id using a dictionary of key value pair to query the desired content.

API Requirement: Anonymous Token.

Declaration

public static IEnumerator GetSpecificMediasForAGivenAssetProcess(string assetId, int channelId, Dictionary<string, string> queryingDictionary, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	assetId	The id of the asset you wish to query.
System.Int32	channelId	The id of the targeted channel.
System.Collections.Generic.Dictionary<System.String, System.String>	queryingDictionary	A key value pair containing query parameters. Those will be matched against the MediaFile's ApiData.
System.Action<System.Collections.Generic.List<MediaFile>>	onSuccess	Contains all the MediaFiles found from the given query. 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

LoadMediaFileContent(Asset, MediaFile, Action<Byte[]>)

Loads the content of the MediaFile and returns it once loaded or downloaded in a callback. If this process failed, the callback will contain a null object.

Declaration

public static void LoadMediaFileContent(Asset asset, MediaFile mediaFile, Action<byte[]> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	The asset which contains the given Mediafile.
MediaFile	mediaFile	The MediaFile you wish to load.
System.Action<System.Byte[]>	onComplete	Occurs when the process is completed. Contains the data of the loaded MediaFile.

LoadMediaFileContentProcess(Asset, MediaFile, Action<Byte[]>)

Loads the content of the MediaFile and returns it once loaded or downloaded in a callback. If this process failed, the callback will contain a null object.

Declaration

public static IEnumerator LoadMediaFileContentProcess(Asset asset, MediaFile mediaFile, Action<byte[]> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	The asset which contains the given Mediafile.
MediaFile	mediaFile	The MediaFile you wish to load.
System.Action<System.Byte[]>	onComplete	Occurs when the process is completed. Contains the data of the loaded MediaFile.

Returns

Type	Description
System.Collections.IEnumerator

PublishExperience(ArTarget, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static void PublishExperience(ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to publish.
System.Action	onSuccess	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.

PublishExperience(Int32, ArTarget, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode. c API Requirement: Session Token.

Declaration

public static void PublishExperience(int channelId, ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
ArTarget	arTarget	The target ArTarget to publish.
System.Action	onSuccess	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.

PublishExperience(Int32, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static void PublishExperience(int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to upload a MediaFile onto.
System.Action	onSuccess	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.

PublishExperience(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given id.

API Requirement: Session Token. ///

Declaration

public static void PublishExperience(int channelId, int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to publish.
System.Action	onSuccess	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.

PublishExperienceProcess(ArTarget, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static IEnumerator PublishExperienceProcess(ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to publish.
System.Action	onSuccess	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

PublishExperienceProcess(Int32, ArTarget, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode. c API Requirement: Session Token.

Declaration

public static IEnumerator PublishExperienceProcess(int channelId, ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
ArTarget	arTarget	The target ArTarget to publish.
System.Action	onSuccess	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

PublishExperienceProcess(Int32, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static IEnumerator PublishExperienceProcess(int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to upload a MediaFile onto.
System.Action	onSuccess	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

PublishExperienceProcess(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Publishes an ArTarget using a given id.

API Requirement: Session Token. ///

Declaration

public static IEnumerator PublishExperienceProcess(int channelId, int arTargetId, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to publish.
System.Action	onSuccess	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

RemoveMediaFromArTarget(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

API Requirement: Session Token.

Declaration

public static void RemoveMediaFromArTarget(int arTargetId, int arMediaId, Action onSuccess, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Action	onSuccess	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.

RemoveMediaFromArTarget(Int32, Int32, Boolean, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget. Variant allowing to delete the Media from the library.

API Requirement: Session Token.

Declaration

public static void RemoveMediaFromArTarget(int arTargetId, int arMediaId, bool doDeleteMediaFromLibrary = false, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Boolean	doDeleteMediaFromLibrary	Whether or not the media being replaced should be deleted from the library.
System.Action	onSuccess	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.

RemoveMediaFromArTarget(Int32, Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

API Requirement: Session Token.

Declaration

public static void RemoveMediaFromArTarget(int channelId, int arTargetId, int arMediaId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Action	onSuccess	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.

RemoveMediaFromArTarget(Int32, Int32, Int32, Boolean, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget. Variant allowing to delete the Media from the library.

API Requirement: Session Token.

Declaration

public static void RemoveMediaFromArTarget(int channelId, int arTargetId, int arMediaId, bool doDeleteMediaFromLibrary = false, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Boolean	doDeleteMediaFromLibrary	Whether or not the media being replaced should be deleted from the library.
System.Action	onSuccess	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.

RemoveMediaFromArTargetProcess(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

API Requirement: Session Token.

Declaration

public static IEnumerator RemoveMediaFromArTargetProcess(int arTargetId, int arMediaId, Action onSuccess, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Action	onSuccess	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

RemoveMediaFromArTargetProcess(Int32, Int32, Boolean, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget. Variant allowing to delete the Media from the library.

API Requirement: Session Token.

Declaration

public static IEnumerator RemoveMediaFromArTargetProcess(int arTargetId, int arMediaId, bool doDeleteMediaFromLibrary = false, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Boolean	doDeleteMediaFromLibrary	Whether or not the media being replaced should be deleted from the library.
System.Action	onSuccess	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

RemoveMediaFromArTargetProcess(Int32, Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

API Requirement: Session Token.

Declaration

public static IEnumerator RemoveMediaFromArTargetProcess(int channelId, int arTargetId, int arMediaId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Action	onSuccess	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

RemoveMediaFromArTargetProcess(Int32, Int32, Int32, Boolean, Action, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget. Variant allowing to delete the Media from the library.

API Requirement: Session Token.

Declaration

public static IEnumerator RemoveMediaFromArTargetProcess(int channelId, int arTargetId, int arMediaId, bool doDeleteMediaFromLibrary, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget which contains the MediaFile to remove.
System.Int32	arMediaId	The id of the MediaFile to remove from the ArTarget.
System.Boolean	doDeleteMediaFromLibrary	Whether or not the media being replaced should be deleted from the library.
System.Action	onSuccess	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

UnpublishExperience(ArTarget, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static void UnpublishExperience(ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to unpublish.
System.Action	onSuccess	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.

UnpublishExperience(Int32, ArTarget, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static void UnpublishExperience(int channelId, ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
ArTarget	arTarget	The target ArTarget to unpublish.
System.Action	onSuccess	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.

UnpublishExperience(Int32, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static void UnpublishExperience(int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to unpublish.
System.Action	onSuccess	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.

UnpublishExperience(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static void UnpublishExperience(int channelId, int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to unpublish.
System.Action	onSuccess	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.

UnpublishExperienceProcess(ArTarget, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static IEnumerator UnpublishExperienceProcess(ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to unpublish.
System.Action	onSuccess	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

UnpublishExperienceProcess(Int32, ArTarget, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given target. Do note that only its arTargetId will be used and the ApiData will not be overrode.

API Requirement: Session Token.

Declaration

public static IEnumerator UnpublishExperienceProcess(int channelId, ArTarget arTarget, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
ArTarget	arTarget	The target ArTarget to unpublish.
System.Action	onSuccess	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

UnpublishExperienceProcess(Int32, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static IEnumerator UnpublishExperienceProcess(int arTargetId, Action onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The target ArTarget to unpublish.
System.Action	onSuccess	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

UnpublishExperienceProcess(Int32, Int32, Action, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given id.

API Requirement: Session Token.

Declaration

public static IEnumerator UnpublishExperienceProcess(int channelId, int arTargetId, Action onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The target ArTarget to unpublish.
System.Action	onSuccess	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

UpdateExperienceMedia(Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Updates a Media inside an experience on the EMS using an arTargetId and the new media content.

API Requirement: Session Token.

Declaration

public static void UpdateExperienceMedia(int arTargetId, MediaFile mediaData, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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.

UpdateExperienceMedia(Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Updates a Media inside an experience on the EMS using an arTargetId and the new media content. Optionally, the file attached to this media can be replaced, and the media can either be kept or deleted from the library.

API Requirement: Session Token.

Declaration

public static void UpdateExperienceMedia(int arTargetId, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Object	mediaObjectReplacement	The object you wish to upload. The MediaFile needs to contain the updated information about this file (filename, mimetype, etc).
System.Boolean	doDeleteMediaFromLibrary	Whether the media being replaced should be deleted from the library.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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.

UpdateExperienceMedia(Int32, Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Updates a Media inside an experience on the EMS using an arTargetId and the new media content.

API Requirement: Session Token.

Declaration

public static void UpdateExperienceMedia(int channelId, int arTargetId, MediaFile mediaData, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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.

UpdateExperienceMedia(Int32, Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static void UpdateExperienceMedia(int channelId, int arTargetId, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Object	mediaObjectReplacement	The object you wish to upload. The MediaFile needs to contain the updated information about this file (filename, mimetype, etc).
System.Boolean	doDeleteMediaFromLibrary	Whether the media being replaced should be deleted from the library.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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.

UpdateExperienceMediaProcess(Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Updates a Media inside an experience on the EMS using an arTargetId and the new media content.

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateExperienceMediaProcess(int arTargetId, MediaFile mediaData, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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

UpdateExperienceMediaProcess(Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateExperienceMediaProcess(int arTargetId, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Object	mediaObjectReplacement	The object you wish to upload. The MediaFile needs to contain the updated information about this file (filename, mimetype, etc).
System.Boolean	doDeleteMediaFromLibrary	Whether the media being replaced should be deleted from the library.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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

UpdateExperienceMediaProcess(Int32, Int32, MediaFile, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

Updates a Media inside an experience on the EMS using an arTargetId and the new media content.

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateExperienceMediaProcess(int channelId, int arTargetId, MediaFile mediaData, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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

UpdateExperienceMediaProcess(Int32, Int32, MediaFile, Object, Boolean, Action<MediaFile>, Action<EmsError>, Action<Boolean>)

API Requirement: Session Token.

Declaration

public static IEnumerator UpdateExperienceMediaProcess(int channelId, int arTargetId, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Int32	arTargetId	The id of the ArTarget which contains the MediaFile you wish to update or replace.
MediaFile	mediaData	The mediaFile of the media you wish to update. Make sure that the arMediaId is valid.
System.Object	mediaObjectReplacement	The object you wish to upload. The MediaFile needs to contain the updated information about this file (filename, mimetype, etc).
System.Boolean	doDeleteMediaFromLibrary	Whether the media being replaced should be deleted from the library.
System.Action<MediaFile>	onSuccess	Contains the media pushed 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)