@keymaster/connect / KeymasterConnectOptions

Interface: KeymasterConnectOptions

Configuration for KeymasterConnectClient.

Properties overview

Property	Type	Required	Description
targetOrigin	string	Yes	Exact Keymaster deployment origin supplied by the host application.
mode?	KeymasterConnectMode	No	popup for direct integrations; appView for apps launched by Keymaster.
popupPath?	string	No	Session Window path relative to targetOrigin.
popupName?	string	No	Browser window name reused by direct integrations.
popupWidth?	number	No	—
popupHeight?	number	No	—
readyTimeoutMs?	number	No	Maximum wait for a popup-mode ready message.
requestTimeoutMs?	number	No	Default request timeout.
closePollMs?	number	No	Session Window close detection interval.
onEvent?	(event) => void	No	Receives appmsg.message_received and broadcast.message_received server-pushed events.
onStateChange?	(state) => void	No	Receives transport lifecycle changes.
environment?	KeymasterBrowserEnvironment	No	Optional browser adapter, normally only supplied by tests.

Properties

targetOrigin

targetOrigin: string

Exact Keymaster deployment origin supplied by the host application.

---

mode?

optional mode?: KeymasterConnectMode

popup for direct integrations; appView for apps launched by Keymaster.

---

popupPath?

optional popupPath?: string

Session Window path relative to targetOrigin.

---

popupName?

optional popupName?: string

Browser window name reused by direct integrations.

---

popupWidth?

optional popupWidth?: number

---

popupHeight?

optional popupHeight?: number

---

readyTimeoutMs?

optional readyTimeoutMs?: number

Maximum wait for a popup-mode ready message. Defaults to 30 seconds.

---

requestTimeoutMs?

optional requestTimeoutMs?: number

Default request timeout. Defaults to two minutes.

---

closePollMs?

optional closePollMs?: number

Session Window close detection interval. Defaults to 500ms.

---

onEvent?

optional onEvent?: (event) => void

Receives appmsg.message_received and broadcast.message_received server-pushed events. Their payloads are respectively AppMsgMessageReceivedEventData and BroadcastMessageReceivedEventData.

Parameters

event

ProtocolEventMessage

Returns

void

---

onStateChange?

optional onStateChange?: (state) => void

Receives transport lifecycle changes.

Parameters

state

KeymasterConnectState

Returns

void

---

environment?

optional environment?: KeymasterBrowserEnvironment

Optional browser adapter, normally only supplied by tests.