Namespace: Publish

Methods

Appearition.Publish.ConfigurationUiUrl (providerName, item, requestOptions) static

Retrieves the URL to the custom UI for the provider for configuring publisher

Name	Type	Description
providerName	string	the name of the provider to return the records for
item	any	contains the details of the item/record
requestOptions	any	configure callbacks

Appearition.Publish.ListProviders (requestOptions) static

Retrieves a list of library providers available to the user

Name	Type	Description
requestOptions	any	configure callbacks

Appearition.Publish.Publish (providerName, item, requestOptions) static

Publishes an item/record to the given provider

Name	Type	Description
providerName	string	the name of the provider to return the records for
item	any	contains the details of the item/record
requestOptions	any	configure callbacks

Appearition.Publish.Status (providerName, item, requestOptions) static

Retrieve the ItemState of an item/record in the given provider

Name	Type	Description
providerName	string	the name of the provider to return the records for
item	any	contains the details of the item/record
requestOptions	any	configure callbacks

Appearition.Publish.Unpublish (providerName, item, requestOptions) static

Unpublishes an item/record from the given provider

Name	Type	Description
providerName	string	the name of the provider to return the records for
item	any	contains the details of the item/record
requestOptions	any	configure callbacks

Type Definitions

Appearition.Publish.Item

Holds the identifiers of the specific content item

Properties:

Name	Type	Description
arTargetKey	string	Identifier to the AR record that needs publishing
arTargetId	string	Identifier to the AR record that needs publishing
channelId	string	Identifier to the channel where the AR record resides
channelKey	string	Identifier to the channel where the AR record resides
properties	Array.<any>	A collection of key value pairs that can be provided to the publisher (extensibility purposes)

Appearition.Publish.ItemStatus

Holds information about the state of an item/record in a specific publisher

Properties:

Name	Type	Description
isPublishing	boolean	Indicates if the item is in the process of being published by the provider
isPublished	boolean	Indicates if the item has completed processing and has been published by the provider
isUnpublishing	boolean	Indicates if the item is in the process of being unpublished by the provider
isUnpublished	boolean	Indicates if the item has completed processing and has been unpublished by the provider
isError	boolean	Indicates if the provider has encountered a problem processing the item
errorMessage	string	If an error has occured, information about that is available in this field
status	string	Text describing the current state of the item according to the provider