@interopio/browser API Reference

Access via:io.notifications

19 Methods

clear()⚓︎

(id: string) => Promise<void>

Clears a specified notification.

Parameters (1)

Name Type Required Description
id⚓︎ string

The id of the notification to be removed.

clearAll()⚓︎

() => Promise<void>

Removes all known notifications from the system.

clearOld()⚓︎

() => Promise<void>

Clears all notifications that the user has already seen.

click()⚓︎

(id: string, action?: string) => Promise<void>

Issues a programmatic click on a notification.

Parameters (2)

Name Type Required Description
id⚓︎ string

The id of the notification to click on.
action⚓︎ string x x

configure()⚓︎

(options: Configuration) => Promise<void>

Configures the Global notification settings.

Parameters (1)

Name Type Required Description
options⚓︎ Configuration

configuration options

getConfiguration()⚓︎

() => Promise<Configuration>

Retrieves the current global notification settings.

getFilter()⚓︎

() => Promise<NotificationFilter>

Retrieves the current filter with apps allowed or not allowed to raise notifications.

getPermission()⚓︎

() => Promise<"default" | "granted" | "denied">

io.Connect Browser only. Retrieves the state of the native browser notification permission for the platform.

list()⚓︎

() => Promise<NotificationData[]>

Returns a list of all known notifications.

onActiveCountChanged()⚓︎

(callback: (info: { count: number; }) => void) => UnsubscribeFunction

Notifies when the number of active notification is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (info: { count: number; }) => void

Callback function for handling the event.

onClosed()⚓︎

(callback: (notification: { id: string }) => void) => UnsubscribeFunction

Notifies the user when a notification was removed via the Notifications API.

Parameters (1)

Name Type Required Description
callback⚓︎ (notification: { id: string }) => void

A function which will be called when a notification is removed.

onConfigurationChanged()⚓︎

(callback: (configuration: Configuration) => void) => UnsubscribeFunction

Notifies when the global notification settings are changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (configuration: Configuration) => void

Callback function for handling the event.

onCounterChanged()⚓︎

(callback: (info: { count: number; }) => void) => UnsubscribeFunction

Alias for onActiveCountChanged() for compatibility with io.Connect Desktop.

io.Connect Browser 4.0

Parameters (1)

Name Type Required Description
callback⚓︎ (info: { count: number; }) => void

Callback function for handling the event.

onRaised()⚓︎

(callback: (notification: NotificationData) => void) => UnsubscribeFunction

Notifies the user of any new raised notifications via the Notifications API.

Parameters (1)

Name Type Required Description
callback⚓︎ (notification: NotificationData) => void

A function which will be called when a new notification is raised.

onStateChanged()⚓︎

(callback: (notification: { id: string; }, state: State) => void) => UnsubscribeFunction

Notifies when the state of a notification is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (notification: { id: string; }, state: State) => void

Callback function for handling the event.

raise()⚓︎

(notification: RaiseOptions) => Promise<Notification>

Raises a new notification

Parameters (1)

Name Type Required Description
notification⚓︎ RaiseOptions

notification options

requestPermission()⚓︎

() => Promise<boolean>

io.Connect Browser only. Triggers the native browser permission dialog. Must only be called from within a platform.

setFilter()⚓︎

(filter: NotificationFilter) => Promise<NotificationFilter>

Sets a filter with apps allowed or not allowed to raise notifications.

Parameters (1)

Name Type Required Description
filter⚓︎ NotificationFilter

Filter with names of apps allowed or not allowed to raise notifications.

setState()⚓︎

(id: string, state: State) => Promise<void>

Sets the state of a notification.

Parameters (2)

Name Type Required Description
id⚓︎ string

ID of the notification to change.
state⚓︎ State

Value for the new notification state.