Skip to main content

Interface: MountARPagePayload

Extends​

Properties​

CDNPath?​

optional CDNPath: string

URL to storage/CDN

Inherited from​

EmbedPayloadPartial.CDNPath

allowScaling?​

optional allowScaling: boolean

If true, scaling will be available for user

appUrl?​

optional appUrl: string

App url for return path

arShortCode?​

optional arShortCode: string

AR short code for product

baseURL?​

optional baseURL: string

URL to page API

Inherited from​

EmbedPayloadPartial.baseURL

customerId​

customerId: string

ID of current customer from witch fetch data

Inherited from​

EmbedPayloadPartial.customerId

elementId?​

optional elementId: string

Deprecated​

ID of HTML element on which mount tree. No longer supported. Please use uid and data-mimeeq-short-code combination instead

Inherited from​

EmbedPayloadPartial.elementId

incompatible?​

optional incompatible: boolean

If true it will display view for incompatible device

locale​

locale: string

Code of current locale

Inherited from​

EmbedPayloadPartial.locale

onEventDispatch?​

optional onEventDispatch: EventDispatchCallback<any>

Custom events callback

Inherited from​

EmbedPayloadPartial.onEventDispatch

renderOnMount​

renderOnMount: boolean

If true embed will be rendered into DOM on mount

uid​

uid: string

Embed instance unique id. Typically, embed shortcode. If passed app will try to mount into html element with data-mimmeq-shortcode set to this value and use env for this id

Inherited from​

EmbedPayloadPartial.uid

withModal?​

optional withModal: boolean

If true it will be rendered at modal

withWatcher?​

optional withWatcher: boolean

If true will assign "sandbox" logic to components

Inherited from​

EmbedPayloadPartial.withWatcher