Search Docs
Loading...
Skip to content

Class: UserInterfaceAPI

A public interface for controlling the UI of the Creative Editor SDK

Constructors#

Constructor#


UserInterfaceAPI

Methods#

setGlobalStateValue()#


| Type Parameter | | —— | | T |

Parameters#

Parameter Type
id string
value T

Returns#

void

Signature#

setGlobalStateValue(id: string, value: T): void

getGlobalStateValue()#


| Type Parameter | | —— | | T |

Parameters#

Parameter Type
id string
defaultValue? T

Returns#

T

Signature#

getGlobalStateValue(id: string, defaultValue?: T): T

hasGlobalStateValue()#


| Parameter | Type | | —— | —— | | id | string |

Returns#

boolean

Signature#

hasGlobalStateValue(id: string): boolean

onGlobalStateChanged()#


| Type Parameter | | —— | | T |

Parameters#

Parameter Type
id string
callback (value) => void

Returns#

() => void

Signature#

onGlobalStateChanged(id: string, callback: (value: T) => void): () => void