Skip to content

MessageAPI

Defined in: jsEngine/api/MessageAPI.ts:7

Constructors

new MessageAPI()

new MessageAPI(apiInstance): MessageAPI

Defined in: jsEngine/api/MessageAPI.ts:11

Parameters

Parameter Type

apiInstance

API

Returns

MessageAPI

Properties

apiInstance

readonly apiInstance: API

Defined in: jsEngine/api/MessageAPI.ts:8


messageManager

readonly messageManager: MessageManager

Defined in: jsEngine/api/MessageAPI.ts:9

Methods

createMessage()

createMessage(type, title, content, code): MessageWrapper

Defined in: jsEngine/api/MessageAPI.ts:16

Parameters

Parameter Type Default value

type

MessageType

undefined

title

string

undefined

content

string

undefined

code

string

''

Returns

MessageWrapper


getMessageById()

getMessageById(id): undefined | MessageWrapper

Defined in: jsEngine/api/MessageAPI.ts:27

Parameters

Parameter Type

id

string

Returns

undefined | MessageWrapper


getMessagesForInstance()

getMessagesForInstance(): MessageWrapper[]

Defined in: jsEngine/api/MessageAPI.ts:33

Returns

MessageWrapper[]