Namespace: Appearition

Namespaces

Alarms

ArTargetImageAndMedia

Asset

Authentication

Channel

ContentLibrary

Form

GeneralDocument

Job

Location

Logger

Mop

ObjectRecognition

Packaging

Part

Persona

Publish

RefType

Site

User

Methods

Appearition.ArTargetMediaFileAsAuthorisedUrl (url) static

Will add the token and api version to the end of the URL for a MediaFile on the AR Target record

Name	Type	Description
url	string	The base URL of the instance of the Appearition platform

Appearition.AssetMediaFileAsAuthorisedUrl (url) static

Will add the token and api version to the end of the URL for a MediaFile on the Asset record

Name	Type	Description
url	string	The base URL of the instance of the Appearition platform

Appearition.AuthorisedVersionedUrl (url, apiVersion) static

Will add the token and api version to the end of the given URL

Name	Type	Description
url	string	The base URL of the instance of the Appearition platform
apiVersion	number	The specific version of the API to call

Appearition.downloadFileAsDataUrl (url, apiVersion, successResponseCallback, failResponseCallback, beforeSendCallback, completeCallback) protectedstatic

Invokes a HTTP GET request to the Appearition platform to download a file and convert it to a base64 data URL

Name	Type	Description
url	string	The intended URL
apiVersion	string	The version of the API being invoked
successResponseCallback	any	a function that will be called when a successful response has been received from the request
failResponseCallback	any	a function that will be called when the request failed
beforeSendCallback	any	a function that will be called just before the request is made. Use this if you want to do something like pop up a message or even block user input
completeCallback	any	a function that will be called one the request completes. This is agnostic of success or failure. You can use this to show a message or unblock user input if you blocked it before send

Appearition.FileAsAuthorisedUrl (url) static

Will add the token and api version to the end of the URL

Name	Type	Description
url	string	The base URL of the instance of the Appearition platform

Appearition.getRequest (url, apiVersion, successResponseCallback, failResponseCallback, beforeSendCallback, completeCallback) protectedstatic

Invokes a HTTP GET request to the Appearition platform

Name	Type	Description
url	string	The intended URL
apiVersion	string	The version of the API being invoked
successResponseCallback	any	a function that will be called when a successful response has been received from the request
failResponseCallback	any	a function that will be called when the request failed
beforeSendCallback	any	a function that will be called just before the request is made. Use this if you want to do something like pop up a message or even block user input
completeCallback	any	a function that will be called one the request completes. This is agnostic of success or failure. You can use this to show a message or unblock user input if you blocked it before send

Appearition.Init (baseApiUrl, appId, anonymousToken, channelId) static

Will set up the SDK with your supplied credentials

Name	Type	Description
baseApiUrl	string	The base URL of the instance of the Appearition platform
appId	string	Your registered application name. Refer to the API Access in the Appearition platform portal
anonymousToken	string	Your generated UUID token which is not linked to a specific user. Refer to the API Access in the Appearition platform portal
channelId	number	The specific channel you want to login to

Appearition.postFile (url, apiVersion, formData, dataType, progressCallback, successResponseCallback, failResponseCallback, beforeSendCallback, completeCallback) protectedstatic

Invokes a HTTP POST request with multipart content to the Appearition platform and provides progress feedback

Name	Type	Description
url	string	The intended URL
apiVersion	any	The version of the API being invoked
formData	object	The raw data that will be posted in the body of the request
dataType	string	the type of data that is being posted in the body of the request (default = json)
progressCallback	any	a function that will be called as the upload progresses
successResponseCallback	any	a function that will be called when a successful response has been received from the request
failResponseCallback	any	a function that will be called when the request failed
beforeSendCallback	any	a function that will be called just before the request is made. Use this if you want to do something like pop up a message or even block user input
completeCallback	any	a function that will be called one the request completes. This is agnostic of success or failure. You can use this to show a message or unblock user input if you blocked it before send

Appearition.postRequest (url, apiVersion, postData, contentType, successResponseCallback, failResponseCallback, beforeSendCallback, completeCallback) protectedstatic

Invokes a HTTP POST request to the Appearition platform

Name	Type	Description
url	string	The intended URL
apiVersion	any	The version of the API being invoked
postData	object	The raw data that will be posted in the body of the request
contentType	string	the type of data that is being posted in the body of the request
successResponseCallback	any	a function that will be called when a successful response has been received from the request
failResponseCallback	any	a function that will be called when the request failed
beforeSendCallback	any	a function that will be called just before the request is made. Use this if you want to do something like pop up a message or even block user input
completeCallback	any	a function that will be called one the request completes. This is agnostic of success or failure. You can use this to show a message or unblock user input if you blocked it before send

Appearition.RequestOptions ()object static

A general construct for injecting logic into requests to the EMS

Returns:

Type	Description
object	empty JSON object

Type Definitions

Appearition.Credentials

A construct that holds key properties for connecting to the Appearition platform

Properties:

Name	Type	Description
baseApiUrl	string	The URL to the Appearition Platform host
appId	string	Your apps unique identifier that has been registered on the instance of the Appearition platform (refer to API Access screen in portal)
anonymousToken	string	This is a UUID generated by the Appearition platform for your registered application (refer to API Access screen in portal).
sessionToken	string	The unique UUID returned as part of the login process (see authentication)
channelId	number	Information on the Appearition platform is organised into channels. Depending on your level of subscription, you may have access to one or many channels. You may leave this as zero and it request will return all of your records across all of your channels.
isAuthenticated	boolean	true|false. Indicates if the session token is still valid

Appearition.ListItemViewModel

A simple model to hold an item that appears in a list

Properties:

Name	Type	Description
Id	number	Identifies the item in the list
Name	string	Descriptive text of the item

Appearition.SelectListItem

This is data structure hold an item that can be shown in a list for a user to choose from

Properties:

Name	Type	Description
Disabled	boolean	Indicates the item cannot be selected from the list
Selected	boolean	Indicates if the item has been selected in the list
Text	string	The display text of the item
Value	string	The value of the item in the list. It may be the same as Text or it can differ
Group	object	Not used