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<K>()

BaseHandler.GetApiJsonFullPath<T, K>()

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile)

BaseHandler.GetApiJsonFullPath<T, K>(UserProfile, Int32, String)

BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile, Int32, String)

BaseHandler.GetApiDownloadedBytesFullPath<T, K>(T, UserProfile, Int32, String)

BaseHandler.GetContentFromFileProcess(String, Action<Byte[]>, DataTransferStatus)

BaseHandler.SaveContentToFileProcess(Byte[], String, Action<Boolean>)

BaseHandler.DeleteFileProcess(String, Action<Boolean>)

BaseHandler.CopyFileToDestinationProcess(String, String, Action<Boolean>)

BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)

BaseHandler.GetChecksumFromExistingFile(String)

BaseHandler.ClearHandlerCache<T>(Action<Boolean>)

BaseHandler.TokenUsedForDownloads

BaseHandler.DownloadGenericFile(String, String, String, Boolean, Action<Byte[]>, DataTransferStatus)

BaseHandler.GetEmsContentFileSize(String, Action<Nullable<Int64>>)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Appearition.ArTargetImageAndMedia

Assembly: Appearition.SDK.dll

Syntax

public class ArTargetHandler : BaseHandler

Methods

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

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

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<ArTarget, 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(ArTarget, MediaFile, Boolean, Action<ArTarget, 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.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Action<ArTarget, 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.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Boolean, Action<ArTarget, MediaFile>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Declaration

public static void AddMediaToExistingExperience(ArTarget arTarget, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<ArTarget, MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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.
DataTransferStatus	uploadTransferStatus

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

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

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The experience you wish to add a media to.
MediaFile	data	The template MediaFile ApiData to upload on the given ArTarget.
System.Action<ArTarget, 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(ArTarget, MediaFile, Boolean, Action<ArTarget, 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.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Action<ArTarget, 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.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Boolean, Action<ArTarget, MediaFile>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Declaration

public static IEnumerator AddMediaToExistingExperienceProcess(ArTarget arTarget, MediaFile data, object mediaToUpload, bool publishOnComplete, Action<ArTarget, MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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.
DataTransferStatus	uploadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

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

Adds a given experience tag to a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Given ArTarget.
System.String	tag	The new tag to add to the ArTarget.
System.Action<ArTarget>	onSuccess	Contains the modified ArTarget. 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.

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

Adds a given experience tag to a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Given ArTarget.
System.String	tag	The new tag to add to the ArTarget.
System.Action<ArTarget>	onSuccess	Contains the modified ArTarget. 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

AddTargetImageToArTarget(ArTarget, String, Texture, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Add a new Target Image to an existing ArTarget.

Declaration

public static void AddTargetImageToArTarget(ArTarget arTarget, string newTargetImageFileName, Texture newTargetImage, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The ArTarget you wish to add a TargetImage onto.
System.String	newTargetImageFileName	The filename (including extension) of the new Target Image you're willing to add. If left blank, a name will be generated.
UnityEngine.Texture	newTargetImage	The texture of the new Target Image you're willing to add.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget containing the TargetImage newly added to it. Only called if the request has succeeded..
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.
DataTransferStatus	uploadTransferStatus	Transfer progress.

AddTargetImageToArTargetProcess(ArTarget, String, Texture, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Add a new Target Image to an existing ArTarget.

Declaration

public static IEnumerator AddTargetImageToArTargetProcess(ArTarget arTarget, string newTargetImageFileName, Texture newTargetImage, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The ArTarget you wish to add a TargetImage onto.
System.String	newTargetImageFileName	The filename (including extension) of the new Target Image you're willing to add. If left blank, a name will be generated.
UnityEngine.Texture	newTargetImage	The texture of the new Target Image you're willing to add.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget containing the TargetImage newly added to it. Only called if the request has succeeded..
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.
DataTransferStatus	uploadTransferStatus	Transfer progress.

Returns

Type	Description
System.Collections.IEnumerator

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

Changes the copyrightInfo of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newCopyrightInfo	New copyright info for the Experience.
System.Action<ArTarget>	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.

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

Changes the copyrightInfo of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newCopyrightInfo	New copyright info for the Experience.
System.Action<ArTarget>	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

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

Changes the long description of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newLongDescription	New long description for the Experience.
System.Action<ArTarget>	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.

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

Changes the long description of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newLongDescription	New long description for the Experience.
System.Action<ArTarget>	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

ChangeExperienceName(ArTarget, String, Action<ArTarget>, 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.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The ArTarget to rename.
System.String	newName	New name for the Experience.
System.Action<ArTarget>	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(ArTarget, String, Action<ArTarget>, 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.

Declaration

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

Parameters

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

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

Changes the short description of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newShortDescription	New short description for the Experience.
System.Action<ArTarget>	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.

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

Changes the short description of the experience as displayed on the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.String	newShortDescription	New short description for the Experience.
System.Action<ArTarget>	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.

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.

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus uploadTransferStatus = 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.
DataTransferStatus	uploadTransferStatus

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

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

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>)

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.

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus uploadTransferStatus = 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.
DataTransferStatus	uploadTransferStatus

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

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

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>)

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.

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>)

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus uploadTransferStatus = 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.
DataTransferStatus	uploadTransferStatus

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.

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>)

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.

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>)

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus uploadTransferStatus = 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.
DataTransferStatus	uploadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

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

Deletes the given experience from the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	ArTarget to delete.
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.

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

Deletes the given experience from the EMS.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	ArTarget to delete.
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

DownloadAssetsContent<T>(IEnumerable<T>, Boolean, Boolean, Boolean, DataTransferStatus)

Downloads the selected content of a given asset.

Declaration

public static IEnumerator DownloadAssetsContent<T>(IEnumerable<T> contents, bool downloadTargetImages, bool downloadPreDownload = true, bool downloadAllContent = false, DataTransferStatus downloadTransferStatus = null)
    where T : Asset

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<T>	contents
System.Boolean	downloadTargetImages
System.Boolean	downloadPreDownload
System.Boolean	downloadAllContent
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

Type Parameters

Name	Description
T

GetAllAvailableTagsForCurrentUser(Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllAvailableTagsForCurrentUser(Int32, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

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

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllAvailableTagsForCurrentUserProcess(Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetAllAvailableTagsForCurrentUserProcess(Int32, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

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

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetAllRegisteredTagsInChannel(Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags registered on the channel selected in the current user profile.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllRegisteredTagsInChannel(Int32, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags registered on the channel of a given id.

Declaration

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

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllRegisteredTagsInChannelProcess(Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags registered on the channel selected in the current user profile.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetAllRegisteredTagsInChannelProcess(Int32, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags registered on the channel of a given id.

Declaration

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

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetAllRelatedTags(Int32, String, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

public static void GetAllRelatedTags(int channelId, string targetTag, Action<List<string>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.String	targetTag
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllRelatedTags(String, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

public static void GetAllRelatedTags(string targetTag, Action<List<string>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	targetTag
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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.

GetAllRelatedTagsProcess(Int32, String, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

public static IEnumerator GetAllRelatedTagsProcess(int channelId, string targetTag, Action<List<string>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	Target Channel ID
System.String	targetTag
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetAllRelatedTagsProcess(String, Action<List<String>>, Action<EmsError>, Action<Boolean>)

Fetch all the experience tags the current user can set to an experience.

Declaration

public static IEnumerator GetAllRelatedTagsProcess(string targetTag, Action<List<string>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.String	targetTag
System.Action<System.Collections.Generic.List<System.String>>	onSuccess	Contains all the tags from 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

GetArTargetCopyrightInfo(ArTarget, Action<ArTarget, CopyrightInfo>, Action<EmsError>, Action<Boolean>)

Fetch the copyright info for a single ArTarget, and sets it to the appropriate field. Also provides the full copyright information.

Offline Capability.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Target arTarget
System.Action<ArTarget, CopyrightInfo>	onSuccess	Contains all the tags from 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.

GetArTargetCopyrightInfoProcess(ArTarget, Action<ArTarget, CopyrightInfo>, Action<EmsError>, Action<Boolean>)

Fetch the copyright info for a single ArTarget, and sets it to the appropriate field. Also provides the full copyright information.

Offline Capability.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Target arTarget
System.Action<ArTarget, CopyrightInfo>	onSuccess	Contains all the tags from 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

GetChannelArTargets(Action<List<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.

Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<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<List<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.

Offline capability.

Declaration

public static void GetChannelArTargets(bool downloadTargetImages, bool downloadContent, Action<List<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<System.Collections.Generic.List<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<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Offline capability.

Declaration

public static void GetChannelArTargets(int channelId, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<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.
DataTransferStatus	downloadTransferStatus

GetChannelArTargets(Int32, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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. Variant also allowing to download the target images, the MediaFile's content, or both.

Offline capability.

Declaration

public static void GetChannelArTargets(int channelId, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = 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<System.Collections.Generic.List<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.
DataTransferStatus	downloadTransferStatus

GetChannelArTargetsProcess(Action<List<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.

Offline capability.

Declaration

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

Parameters

Type	Name	Description
System.Action<System.Collections.Generic.List<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<List<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.

Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(bool downloadTargetImages, bool downloadContent, Action<List<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<System.Collections.Generic.List<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<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(int channelId, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
System.Action<System.Collections.Generic.List<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.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

GetChannelArTargetsProcess(Int32, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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. Variant also allowing to download the target images, the MediaFile's content, or both.

Offline capability.

Declaration

public static IEnumerator GetChannelArTargetsProcess(int channelId, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = 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<System.Collections.Generic.List<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.
DataTransferStatus	downloadTransferStatus

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.

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

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.

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>)

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.

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>, DataTransferStatus)

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.

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, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

GetChannelExperiencesProcess(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.

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>, DataTransferStatus)

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.

Offline capability.

Declaration

public static IEnumerator GetChannelExperiencesProcess(int channelId, List<Asset> reusableList, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

GetDataIntegrationResultP(Asset, MediaFile, Action<String>, Action<EmsError>, Action<Boolean>)

Get the latest Data Integration results for a given media. Optionally, a dictionary of parameters can be provided, which will be swapped with the query's [[]] parameters.

Declaration

public static void GetDataIntegrationResultP(Asset asset, MediaFile media, Action<string> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	Associated Asset
MediaFile	media	Media of type query
System.Action<System.String>	onSuccess
System.Action<EmsError>	onFailure
System.Action<System.Boolean>	onComplete

GetDataIntegrationResultP(Asset, MediaFile, Dictionary<String, String>, Action<String>, Action<EmsError>, Action<Boolean>)

Get the latest Data Integration results for a given media. Optionally, a dictionary of parameters can be provided, which will be swapped with the query's [[]] parameters.

Declaration

public static void GetDataIntegrationResultP(Asset asset, MediaFile media, Dictionary<string, string> parameters, Action<string> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	Associated Asset
MediaFile	media	Media of type query
System.Collections.Generic.Dictionary<System.String, System.String>	parameters	Additional parameters for the query
System.Action<System.String>	onSuccess
System.Action<EmsError>	onFailure
System.Action<System.Boolean>	onComplete

GetDataIntegrationResultProcess(Asset, MediaFile, Action<String>, Action<EmsError>, Action<Boolean>)

Get the latest Data Integration results for a given media. Optionally, a dictionary of parameters can be provided, which will be swapped with the query's [[]] parameters.

Declaration

public static IEnumerator GetDataIntegrationResultProcess(Asset asset, MediaFile media, Action<string> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	Associated Asset
MediaFile	media	Media of type query
System.Action<System.String>	onSuccess
System.Action<EmsError>	onFailure
System.Action<System.Boolean>	onComplete

Returns

Type	Description
System.Collections.IEnumerator

GetDataIntegrationResultProcess(Asset, MediaFile, Dictionary<String, String>, Action<String>, Action<EmsError>, Action<Boolean>)

Get the latest Data Integration results for a given media. Optionally, a dictionary of parameters can be provided, which will be swapped with the query's [[]] parameters.

Declaration

public static IEnumerator GetDataIntegrationResultProcess(Asset asset, MediaFile media, Dictionary<string, string> parameters, Action<string> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
Asset	asset	Associated Asset
MediaFile	media	Media of type query
System.Collections.Generic.Dictionary<System.String, System.String>	parameters	Additional parameters for the query
System.Action<System.String>	onSuccess
System.Action<EmsError>	onFailure
System.Action<System.Boolean>	onComplete

Returns

Type	Description
System.Collections.IEnumerator

GetExperienceCopyrightInfo(Asset, Action<Asset>, Action<EmsError>, Action<Boolean>)

Fetch the copyright info for a single asset, and sets it to the appropriate field.

Declaration

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

Parameters

Type	Name	Description
Asset	asset	Target asset
System.Action<Asset>	onSuccess	Contains all the tags from 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.

GetExperienceCopyrightInfoProcess(Asset, Action<Asset>, Action<EmsError>, Action<Boolean>)

Fetch the copyright info for a single asset, and sets it to the appropriate field.

Declaration

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

Parameters

Type	Name	Description
Asset	asset	Target asset
System.Action<Asset>	onSuccess	Contains all the tags from 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

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.

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>, DataTransferStatus)

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

Declaration

public static void GetSingleArTarget(int arTargetId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

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.

Declaration

public static void GetSingleArTarget(int channelId, int arTargetId, 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.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, Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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

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, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

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.

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>, DataTransferStatus)

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

Declaration

public static IEnumerator GetSingleArTargetProcess(int arTargetId, bool downloadTargetImages, bool downloadContent, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = 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.
DataTransferStatus	downloadTransferStatus

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.

Declaration

public static IEnumerator GetSingleArTargetProcess(int channelId, int arTargetId, 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.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, Int32, Boolean, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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

Declaration

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

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
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.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

GetSpecificArTargetByQuery(ArTarget_List.QueryContent, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificArTargetByQuery(ArTarget_List.QueryContent query, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget_List.QueryContent	query	The given query
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.

GetSpecificArTargetByQuery(ArTarget_List.QueryContent, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificArTargetByQuery(ArTarget_List.QueryContent query, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

GetSpecificArTargetByQuery(Int32, ArTarget_List.QueryContent, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificArTargetByQuery(int channelId, ArTarget_List.QueryContent query, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
ArTarget_List.QueryContent	query	The given query
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.

GetSpecificArTargetByQuery(Int32, ArTarget_List.QueryContent, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificArTargetByQuery(int channelId, ArTarget_List.QueryContent query, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
ArTarget_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

GetSpecificArTargetByQueryProcess(ArTarget_List.QueryContent, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificArTargetByQueryProcess(ArTarget_List.QueryContent query, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget_List.QueryContent	query	The given query
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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

GetSpecificArTargetByQueryProcess(ArTarget_List.QueryContent, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificArTargetByQueryProcess(ArTarget_List.QueryContent query, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

Returns

Type	Description
System.Collections.IEnumerator

GetSpecificArTargetByQueryProcess(Int32, ArTarget_List.QueryContent, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificArTargetByQueryProcess(int channelId, ArTarget_List.QueryContent query, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
ArTarget_List.QueryContent	query	The given query
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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

GetSpecificArTargetByQueryProcess(Int32, ArTarget_List.QueryContent, Boolean, Boolean, Action<List<ArTarget>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific ArTarget in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificArTargetByQueryProcess(int channelId, ArTarget_List.QueryContent query, bool downloadTargetImages, bool downloadContent, Action<List<ArTarget>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
ArTarget_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Action<System.Collections.Generic.List<ArTarget>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

Returns

Type	Description
System.Collections.IEnumerator

GetSpecificExperiencesByQuery(Asset_List.QueryContent, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific experiences in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificExperiencesByQuery(Asset_List.QueryContent query, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
Asset_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Boolean	downloadPreDownloads	Whether to only download the medias from the experiences found with the pre-download flag on them.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

GetSpecificExperiencesByQuery(Int32, Asset_List.QueryContent, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific experiences in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static void GetSpecificExperiencesByQuery(int channelId, Asset_List.QueryContent query, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
Asset_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Boolean	downloadPreDownloads	Whether to only download the medias from the experiences found with the pre-download flag on them.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

GetSpecificExperiencesByQueryProcess(Asset_List.QueryContent, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific experiences in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificExperiencesByQueryProcess(Asset_List.QueryContent query, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
Asset_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Boolean	downloadPreDownloads	Whether to only download the medias from the experiences found with the pre-download flag on them.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

Returns

Type	Description
System.Collections.IEnumerator

GetSpecificExperiencesByQueryProcess(Int32, Asset_List.QueryContent, Boolean, Boolean, Boolean, Action<List<Asset>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Submits a query to find specific experiences in the selected channel. Check out the query class for more info. The paging and quantities returned by the query can be changed within the query class.

Declaration

public static IEnumerator GetSpecificExperiencesByQueryProcess(int channelId, Asset_List.QueryContent query, bool downloadTargetImages, bool downloadContent, bool downloadPreDownloads, Action<List<Asset>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The target channel ID
Asset_List.QueryContent	query	The given query
System.Boolean	downloadTargetImages	Whether to download the target images of the experiences found.
System.Boolean	downloadContent	Whether to download all the medias from the experiences found.
System.Boolean	downloadPreDownloads	Whether to only download the medias from the experiences found with the pre-download flag on them.
System.Action<System.Collections.Generic.List<Asset>>	onSuccess	Contains all the Experiences 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.
DataTransferStatus	downloadTransferStatus	Transfer progress.

Returns

Type	Description
System.Collections.IEnumerator

GetSpecificMediasInAssetByQuery(Int32, 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.

Declaration

public static void GetSpecificMediasInAssetByQuery(int channelId, string assetId, Action<List<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.String	assetId	The id of the asset you wish to query.
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.

GetSpecificMediasInAssetByQuery(Int32, String, Boolean, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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

Declaration

public static void GetSpecificMediasInAssetByQuery(int channelId, string assetId, bool downloadAllContent, Action<List<MediaFile>> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
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.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.
DataTransferStatus	downloadTransferStatus

GetSpecificMediasInAssetByQueryProcess(Int32, 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.

Declaration

public static IEnumerator GetSpecificMediasInAssetByQueryProcess(int channelId, string assetId, Action<List<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.String	assetId	The id of the asset you wish to query.
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

GetSpecificMediasInAssetByQueryProcess(Int32, String, Boolean, Action<List<MediaFile>>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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

Declaration

public static IEnumerator GetSpecificMediasInAssetByQueryProcess(int channelId, string assetId, bool downloadAllContent, Action<List<MediaFile>> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete, DataTransferStatus downloadTransferStatus = null)

Parameters

Type	Name	Description
System.Int32	channelId	The id of the targeted channel.
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.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.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

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

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<Dictionary<string, byte[]>> onComplete = null, DataTransferStatus downloadTransferStatus = 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.Collections.Generic.Dictionary<System.String, System.Byte[]>>	onComplete	Occurs when the process is completed. Contains the data of the loaded MediaFile.
DataTransferStatus	downloadTransferStatus

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

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<Dictionary<string, byte[]>> onComplete = null, DataTransferStatus downloadTransferStatus = 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.Collections.Generic.Dictionary<System.String, System.Byte[]>>	onComplete	Occurs when the process is completed. Contains the data of the loaded MediaFile.
DataTransferStatus	downloadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

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

Locks an experience so that it cannot be edited until unlocked.

Declaration

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

Parameters

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

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

Locks an experience so that it cannot be edited until unlocked.

Declaration

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

Parameters

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

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

Publishes an ArTarget using a given ArTarget, making it visible to Asset / Experience APIs.

Declaration

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

Parameters

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

Publishes an ArTarget using a given ArTarget, making it visible to Asset / Experience APIs. ///

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to publish.
System.Action<ArTarget>	onSuccess	Contains the updated ArTarget. 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(ArTarget, MediaFile, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget which contains the MediaFile to remove.
MediaFile	media	The MediaFile to remove from the ArTarget.
System.Action<ArTarget>	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(ArTarget, MediaFile, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

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

Declaration

public static void RemoveMediaFromArTarget(ArTarget arTarget, MediaFile media, bool doDeleteMediaFromLibrary = false, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget which contains the MediaFile to remove.
MediaFile	media	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<ArTarget>	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(ArTarget, MediaFile, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Removes a Media from a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget which contains the MediaFile to remove.
MediaFile	media	The MediaFile to remove from the ArTarget.
System.Action<ArTarget>	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(ArTarget, MediaFile, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

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

Declaration

public static IEnumerator RemoveMediaFromArTargetProcess(ArTarget arTarget, MediaFile media, bool doDeleteMediaFromLibrary, Action<ArTarget> onSuccess, Action<EmsError> onFailure, Action<bool> onComplete)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget which contains the MediaFile to remove.
MediaFile	media	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<ArTarget>	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

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

Remove a given experience tag from a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Given ArTarget.
System.String	tag	The new tag to add to the ArTarget.
System.Action<ArTarget>	onSuccess	Contains the modified ArTarget. 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.

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

Remove a given experience tag from a given ArTarget.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	Given ArTarget.
System.String	tag	The new tag to add to the ArTarget.
System.Action<ArTarget>	onSuccess	Contains the modified ArTarget. 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

RemoveTargetImageFromArTarget(ArTarget, TargetImage, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Removes a TargetImage from a given ArTarget.

Declaration

public static void RemoveTargetImageFromArTarget(ArTarget arTarget, TargetImage targetImage, bool deleteTargetImageFromLibrary, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget
TargetImage	targetImage	The given TargetImage to remove.
System.Boolean	deleteTargetImageFromLibrary	Whether or not the TargetImage should be removed from the EMS.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget with the given TargetImage removed.. Only called if the request has succeeded..
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.

RemoveTargetImageFromArTargetProcess(ArTarget, TargetImage, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>)

Removes a TargetImage from a given ArTarget.

Declaration

public static IEnumerator RemoveTargetImageFromArTargetProcess(ArTarget arTarget, TargetImage targetImage, bool deleteTargetImageFromLibrary, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget
TargetImage	targetImage	The given TargetImage to remove.
System.Boolean	deleteTargetImageFromLibrary	Whether or not the TargetImage should be removed from the EMS.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget with the given TargetImage removed.. Only called if the request has succeeded..
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

ReplaceTargetImage(ArTarget, TargetImage, String, Texture, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Removes a TargetImage from a given ArTarget.

Declaration

public static void ReplaceTargetImage(ArTarget arTarget, TargetImage targetImageToRemove, string newTargetImageFilename, Texture newTargetImage, bool deleteTargetImageFromLibrary, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget
TargetImage	targetImageToRemove	The given TargetImage to remove.
System.String	newTargetImageFilename	The filename of the new TargetImage to add.
UnityEngine.Texture	newTargetImage	The texture of the new TargetImage to add.
System.Boolean	deleteTargetImageFromLibrary	Whether or not the TargetImage should be removed from the EMS.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget with the given TargetImage removed.. Only called if the request has succeeded..
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.
DataTransferStatus	uploadTransferStatus

ReplaceTargetImageProcess(ArTarget, TargetImage, String, Texture, Boolean, Action<ArTarget>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

Removes a TargetImage from a given ArTarget.

Declaration

public static IEnumerator ReplaceTargetImageProcess(ArTarget arTarget, TargetImage targetImageToRemove, string newTargetImageFilename, Texture newTargetImage, bool deleteTargetImageFromLibrary, Action<ArTarget> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget
TargetImage	targetImageToRemove	The given TargetImage to remove.
System.String	newTargetImageFilename	The filename of the new TargetImage to add.
UnityEngine.Texture	newTargetImage	The texture of the new TargetImage to add.
System.Boolean	deleteTargetImageFromLibrary	Whether or not the TargetImage should be removed from the EMS.
System.Action<ArTarget>	onSuccess	Contains the refreshed ArTarget with the given TargetImage removed.. Only called if the request has succeeded..
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.
DataTransferStatus	uploadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

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

Unlocks an experience so that it can be further edited.

Declaration

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

Parameters

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

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

Unlocks an experience so that it can be further edited.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget.
System.Action<ArTarget>	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<ArTarget>, Action<EmsError>, Action<Boolean>)

Unpublishes an ArTarget using a given ArTarget, making it invisible to Asset / Experience APIs.

Declaration

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

Parameters

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

Unpublishes an ArTarget using a given ArTarget, making it invisible to Asset / Experience APIs.

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	The target ArTarget to unpublish.
System.Action<ArTarget>	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(ArTarget, MediaFile, Action<ArTarget, MediaFile>, Action<EmsError>, Action<Boolean>)

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

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Boolean, Action<ArTarget, MediaFile>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Declaration

public static void UpdateExperienceMedia(ArTarget arTarget, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<ArTarget, MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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.
DataTransferStatus	uploadTransferStatus

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

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

Declaration

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

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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(ArTarget, MediaFile, Object, Boolean, Action<ArTarget, MediaFile>, Action<EmsError>, Action<Boolean>, DataTransferStatus)

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.

Declaration

public static IEnumerator UpdateExperienceMediaProcess(ArTarget arTarget, MediaFile mediaData, object mediaObjectReplacement, bool doDeleteMediaFromLibrary, Action<ArTarget, MediaFile> onSuccess = null, Action<EmsError> onFailure = null, Action<bool> onComplete = null, DataTransferStatus uploadTransferStatus = null)

Parameters

Type	Name	Description
ArTarget	arTarget	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<ArTarget, 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.
DataTransferStatus	uploadTransferStatus

Returns

Type	Description
System.Collections.IEnumerator

Extension Methods

ObjectExtension.ToStream(Object)