Namespaces
Methods
-
Adds a new property for the given record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
propertyDetails
any Holds the propertyKey and Value to update
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Retrieves a list of tags that are available to be added to an experience record
-
Name Type Description arTargetId
number identifies the record to return
tag
string the tag to add
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.AddTargetMarkerFromContentItem (arTargetId, request, requestOptions) static
Set the image from a content item to be a target marker of the experience. If the content item has an image in the files collection, the first image will be used. If there are no images, it will look to use the thumbnail
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
request
Appearition.ArTargetImageAndMedia.AddTargetMarkerFromContentItemViewModel Contains the details of the content item to
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Returns a private media file as a data URL on an AR Target
-
Name Type Description mediaFileId
number identifies the MEDIA FILE on an AR Target record
requestOptions
any configure callbacks
-
Returns a private media file as a data URL on an Asset (i.e. AR Target record that has been published)
-
Name Type Description mediaFileId
number identifies the MEDIA FILE on an AR Target record
requestOptions
any configure callbacks
-
Retrieves a list of content media types available to the user
-
Name Type Description requestOptions
any configure callbacks
-
Retrieves a list of data media types available to the user
-
Name Type Description requestOptions
any configure callbacks
-
Retrieves a list of data transform providers available to the user
-
Name Type Description requestOptions
any configure callbacks
-
Retrieves the copyright info of as specific experience record
-
Name Type Description arTargetId
number identifies the experience record
requestOptions
any configure callbacks
-
Creates a new AR record
-
Name Type Description request
Appearition.ArTargetImageAndMedia.CreateRequest holds the data that will be created
requestOptions
any configure callbacks
-
Creates a new media item on the AR record
-
Name Type Description arTargetId
number identifies the AR record
request
Appearition.ArTargetImageAndMedia.CreateMediaRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.CreatePreviewMediaWithFile (arTargetId, ordinal, isPrivate, fileName, fileContent, requestOptions)Appearition.ArTargetImageAndMedia.PreviewMediaViewModel static
This method adds a media file as a preview item to an AR Target record.
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
ordinal
number The ordinal position of the preview media relative to all the other preview media
isPrivate
boolean If TRUE, then a public open URL will be made available. If FALSE, then only via API call to the platform can the file be read
fileName
string The name of the file being sent up to the server
fileContent
string The file contents that need to be sent up to the server
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
Returns:
Type Description Appearition.ArTargetImageAndMedia.PreviewMediaViewModel -
Appearition.ArTargetImageAndMedia.CreatePreviewMediaWithUrl (arTargetId, ordinal, url, requestOptions)Appearition.ArTargetImageAndMedia.PreviewMediaViewModel static
This method adds a public URL as a preview item to an AR Target record.
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
ordinal
number The ordinal position of the preview media relative to all the other preview media
url
string A public URL which will serve the preview file
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
Returns:
Type Description Appearition.ArTargetImageAndMedia.PreviewMediaViewModel -
Retrieve data stream for a given asset
-
Name Type Description request
Appearition.ArTargetImageAndMedia.DataByAssetRequest Contains the asset id that uniquely identifies the AR experience record and the list of key value pairs that are applied to the data query for this request see DataByAssetRequest
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Retrieve data stream for a given ar target
-
Name Type Description request
Appearition.ArTargetImageAndMedia.DataByKeyRequest Contains the asset id that uniquely identifies the AR experience record and the list of key value pairs that are applied to the data query for this request see DataByAssetRequest
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Deletes the given AR Target record and handles the removal of the target image from the image recognition provider
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Appearition.ArTargetImageAndMedia.DeletePreviewMedia (arTargetId, previewMediaId, requestOptions) static
Deletes the given preview media from the AR Target record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
previewMediaId
number Uniquely identifies preview media on the AR Target record
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Retrieves a specific record with the given id
-
Name Type Description arImageId
number identifies the target image to download
requestOptions
any configure callbacks
-
Retrieves a specific record with the given id
-
Name Type Description arTargetId
number identifies the record to return
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.GetAnonymousWebArAccessCredentials (arTargetId, requestOptions) static
Retrieves the access details for allowing anonymous WebAR for the given record
-
Name Type Description arTargetId
number identifies the AR Target record
requestOptions
any configure callbacks
-
Retrieves a list of tags that are available to be added to an experience record
-
Name Type Description requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.GetPricing (arTargetId, requestOptions)Appearition.ArTargetImageAndMedia.PricingViewModel static
Retrieves the pricing information for an AR Target record
-
Name Type Description arTargetId
any uniquely identifies the AR Target record
requestOptions
any configure callbacks
Returns:
Type Description Appearition.ArTargetImageAndMedia.PricingViewModel -
Retrieves the list of peroties for the given record
-
Name Type Description arTargetId
number identifies the AR Target record
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.GetTargetImageQuality (arTargetId, arImageId, requestOptions)Appearition.ArTargetImageAndMedia.ArImageQualityViewModel static
Retrieves the quality information of a target image for an AR Target record
-
Name Type Description arTargetId
any uniquely identifies the AR Target record
arImageId
any identifies the target image on the AR Target record
requestOptions
any configure callbacks
Returns:
Type Description Appearition.ArTargetImageAndMedia.ArImageQualityViewModel -
Retrieves a base64 serialised version of the file that the given URL links to
-
Name Type Description url
string Contains the link to the file being downloaded
requestOptions
any Contains the configured callback on a successful request
-
Checks if WebAR is available for the given record
-
Name Type Description arTargetId
number identifies the AR Target record
requestOptions
any configure callbacks
-
Checks if WebAR is available for the given record
-
Name Type Description arTargetKey
number identifies the AR Target record
requestOptions
any configure callbacks
-
Retrieves AR Experiences from the Appearition platform for the specified filter criteria
-
Name Type Description request
any data structure holds the filter and paging information for the server
requestOptions
any configure callbacks
-
Retrieves published AR Experiences filtered by given category and probability
-
Name Type Description requestOptions
any Contains the parameters of category and probability and any configured callbacks on a successful or failed request
-
Retrieves all of the published AR Experiences from the Appearition platform for the specified tenant and channel
-
Name Type Description requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.ListPreviewMedia (arTargetId, requestOptions)Array.<Appearition.ArTargetImageAndMedia.PreviewMediaViewModel> static
Retrieves the list of preview media files for an AR Target record
-
Name Type Description arTargetId
any uniquely identifies the AR Target record
requestOptions
any configure callbacks
Returns:
Type Description Array.<Appearition.ArTargetImageAndMedia.PreviewMediaViewModel> -
Locks the experience to prevent any changes
-
Name Type Description arTargetId
number identifies the record to lock
requestOptions
any configure callbacks
-
Retrieve the media for a given asset. If the media is a data query, then the query will be executed, the results will be transformed as specified and then returned
-
Name Type Description request
any Contains the asset id that uniquely identifies the AR experience record and the list of key value pairs that are applied to the data query for this request see DataByAssetRequest
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Publishes the record
-
Name Type Description arTargetId
number identifies the record to return
requestOptions
any configure callbacks
-
Removes the market record from the channel
-
Name Type Description arTargetId
number identifies the record to return
requestOptions
any configure callbacks
-
Retrieves a list of tags that are available to be added to an experience record
-
Name Type Description arTargetId
number identifies the record to return
tag
string the tag to add
requestOptions
any configure callbacks
-
Removes a target image item from the AR record
-
Name Type Description arTargetId
number identifies the AR record
arImageId
number identifies the target image
requestOptions
any configure callbacks
-
Removes media item from the AR record
-
Name Type Description arTargetId
number identifies the AR record
arMediaId
number identifies the media record
requestOptions
any configure callbacks
-
Unlocks the experience to allow changes
-
Name Type Description arTargetId
number identifies the record to lock
requestOptions
any configure callbacks
-
Unpublishes the record
-
Name Type Description arTargetId
number identifies the record to return
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.UpdateAnonymousWebArAccessCredentials (arTargetId, accessDetails, requestOptions) static
Updates the access details for allowing anonymous WebAR for the given record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
accessDetails
any Holds the registered application id and the access token
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Updates the copyright of the record
-
Name Type Description arTargetId
number identifies the record to return
request
Appearition.ArTargetImageAndMedia.UpdateCopyrightInfoRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.UpdateLongDescription (arTargetId, request, requestOptions) static
Updates the long description of the record
-
Name Type Description arTargetId
number identifies the record to return
request
Appearition.ArTargetImageAndMedia.UpdateLongDescriptionRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.UpdateMediaSettings (arTargetId, arMediaId, request, requestOptions) static
Updates the settings associated with a media item
-
Name Type Description arTargetId
number identifies the AR record
arMediaId
number identifies the media record on the AR record
request
Appearition.ArTargetImageAndMedia.UpdateMediaSettingsRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Updates the name of the record
-
Name Type Description arTargetId
number identifies the record to return
request
Appearition.ArTargetImageAndMedia.UpdateNameRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Appearition.ArTargetImageAndMedia.UpdatePreviewMediaDefault (arTargetId, previewMediaId, isDefault, requestOptions) static
Saves the IsDefault value of the preview media of an AR Target record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
previewMediaId
number Uniquely identifies preview media on the AR Target record
isDefault
number TRUE or FALSE
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Appearition.ArTargetImageAndMedia.UpdatePreviewMediaOrdinal (arTargetId, previewMediaId, ordinal, requestOptions) static
Saves the ordinal position of the preview media of an AR Target record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
previewMediaId
number Uniquely identifies preview media on the AR Target record
ordinal
number The ordinal position of the preview media relative to all the other preview media
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Appearition.ArTargetImageAndMedia.UpdatePreviewMediaThumbnail (arTargetId, previewMediaId, isThumbnail, requestOptions) static
Saves the IsThumbnail value of the preview media of an AR Target record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
previewMediaId
number Uniquely identifies preview media on the AR Target record
isThumbnail
number TRUE or FALSE
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Saves the pricing information of an AR Target record
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
request
Appearition.ArTargetImageAndMedia.PricingViewModel holds the pricing information
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Appearition.ArTargetImageAndMedia.UpdateProperty (arTargetId, propertyDetails, requestOptions) static
Updates and existing property
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
propertyDetails
any Holds the propertyKey and Value to update
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Appearition.ArTargetImageAndMedia.UpdateShortDescription (arTargetId, request, requestOptions) static
Updates the short description of the record
-
Name Type Description arTargetId
number identifies the record to return
request
Appearition.ArTargetImageAndMedia.UpdateShortDescriptionRequest hold the data that will sent to be updated
requestOptions
any configure callbacks
-
Disables anonymous access to the AR record for WebAR
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Enables anonymous access to the AR record for WebAR
-
Name Type Description arTargetId
number Uniquely identifies the AR Target record
requestOptions
any Contains the parameters of Channel Id and any configured callbacks on a successful or failed request
-
Returns the QR Code for opening the WebAR viewer if applicable for the give AR record
-
Name Type Description arTargetKey
number identifies the AR Target record
requestOptions
any configure callbacks
-
Returns the QR Code for opening the WebAR viewer if applicable for the give AR record
-
Name Type Description arTargetKey
number identifies the AR Target record
requestOptions
any configure callbacks
Type Definitions
-
Used for the DataByAsset request
-
Properties:
Name Type Description contentItemProviderName
string Identifies the content library that the item exists in
contentItemKey
string Identifies the item within the content library
-
Holds the quality information of a target image on an AR Target record
-
Properties:
Name Type Description arImageId
number Identifies the target image
isReady
boolean Indicates of the image recognition provider has process the image and is ready to start recognising it
isError
boolean Indicates if something has gone wrong during the processing of the target image for recognition
errorMessage
string Descriptive information explaining the state of the image
isQualityChecked
boolean Indicates if a quality check has been made on the target image
isQualityGood
boolean Indicates if the quality of the image, according to the image recognition provider, is good enough for recognition
isQualityWarning
boolean Indicates if the quality of the image, according to the image recognition provider, is OK but there some concern identified
isQualityPoor
boolean Indicates if the quality check of the image, according to the image recognition provider, is poor and recognition may not work
qualityPercentage
number A value between 0-100 where 0 means the features of the image cannot be used for recognition and 100 means the features of the image make it excellent for recognition
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.CreateMedia method
-
Properties:
Name Type Description arMediaId
number leave this empty (zero)
fileName
string the name of the file of the content
url
string the web link to the content
checksum
string Md5 hash of the file contents
mediaType
string The type of media this is
mimeType
string The format of the content item
isPrivate
boolean Whether the content item has a public URL or not
resolution
number The quality level of the content item
language
string the language that this media applies to
isTracking
boolean should the media be augmented over the scanned target marker
isAutoPlay
boolean should the media automatically start when triggered
isPreDownload
boolean should the media content be downloaded before it is triggered
isInteractive
boolean can the user interact with the media content
animationName
string does the media have an animation name. Applies to 3D models
scaleX
number the size of the model to render when triggered
scaleY
number the size of the model to render when triggered
scaleZ
number the size of the model to render when triggered
translationX
number the position of the model to render when triggered
translationY
number the position of the model to render when triggered
translationZ
number the position of the model to render when triggered
rotationX
number the orientation of the model to render when triggered
rotationY
number the orientation of the model to render when triggered
rotationZ
number the orientation of the model to render when triggered
text
string any text value associated with this media
custom
string any custom value associated with this media
contentItemProviderName
string the reference to the library where the media was taken from
contentItemKey
string the identifier of the media item in the library
dataTransform
string contains ProviderName and TemplateText
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.CreateMedia method
-
Properties:
Name Type Description productId
number Identifies the channel to create the new AR record
name
string the name of the AR record
shortDescription
string a short description of the AR record (max 200 chars)
longDescription
string a long description (accepts HTML)
copyrightInfo
string copyright information to be displayed for this AR record
-
Used for the DataByAsset request
-
Properties:
Name Type Description assetId
string A UUID that uniquely identifies the AR Experience record
arMediaId
null Identifies the specific media record which represents the data query
params
Array.<Appearition.ArTargetImageAndMedia.DataByAssetRequestParam> Key value pair sent applied to the data query as part of the request
-
Used for the DataByAsset request
-
Properties:
Name Type Description key
string any string value that will be use in the data query request
value
string any string value which will be replaced for the key in the data query request
-
Used for the DataByAsset request
-
Properties:
Name Type Description arTargetKey
string Uniquely identifies the AR Experience record
arMediaId
null Identifies the specific media record which represents the data query
params
Array.<Appearition.ArTargetImageAndMedia.DataByKeyRequestParam> Key value pair sent applied to the data query as part of the request
-
Used for the DataByKey request
-
Properties:
Name Type Description key
string any string value that will be use in the data query request
value
string any string value which will be replaced for the key in the data query request
-
Holds the details of a preview media item
-
Properties:
Name Type Description previewMediaId
number Identifies the Preview Media for the AR Target record
arTargetId
number Identifies the AR Target record
ordinal
number The order position of this preview media relative to any other preview media for the AR Target
isDefault
boolean TRUE | FALSE, indicates if this preview media is the default one that should be shown first
isThumbnail
boolean TRUE | FALSE, indicates if this preview media can be used as a thumbnail
fileName
string If the media is an uploaded file, this holds the original file name
checksum
string If the media is an uploaded file, this holds the MD5 checksum of the file bytes
url
string The URL to download the media from. If isPrivate=true, then you must invoke the ArTarget/MediaFile method using the previewMediaId
isPrivate
boolean TRUE | FALSE. If FALSE, the url can be called to retrieve the media. If TRUE, you must invoke the ArTarget/MediaFile method using the previewMediaId
-
Holds the details of pricing
-
Properties:
Name Type Description isFree
boolean TRUE | FALSE, indicates if the AR target record has no payment amount
description
string A descriptive text field
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.UpdateCopyrightInfo method
-
Properties:
Name Type Description copyrightInfo
string the Copyright Info of the record
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.UpdateLongDescription method
-
Properties:
Name Type Description longDescription
string the Long Description of the record
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.UpdateMediaSettings method
-
Properties:
Name Type Description arMediaId
number identifies the media record
url
string the web link to the content
mediaType
string The type of media this is
language
string the language that this media applies to
isTracking
boolean should the media be augmented over the scanned target marker
isAutoPlay
boolean should the media automatically start when triggered
isPreDownload
boolean should the media content be downloaded before it is triggered
isInteractive
boolean can the user interact with the media content
animationName
string does the media have an animation name. Applies to 3D models
scaleX
number the size of the model to render when triggered
scaleY
number the size of the model to render when triggered
scaleZ
number the size of the model to render when triggered
translationX
number the position of the model to render when triggered
translationY
number the position of the model to render when triggered
translationZ
number the position of the model to render when triggered
rotationX
number the orientation of the model to render when triggered
rotationY
number the orientation of the model to render when triggered
rotationZ
number the orientation of the model to render when triggered
text
string any text value associated with this media
custom
string any custom value associated with this media
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.UpdateName method
-
Properties:
Name Type Description name
string the name of the record
-
This is the data structure sent for the Appearition.ArTargetImageAndMedia.UpdateShortDescription method
-
Properties:
Name Type Description shortDescription
string the Short Description of the record