In-App Messages

flet_onesignal.in_app_messages.OneSignalInAppMessages

OneSignal In-App Messages namespace.

Provides methods for managing in-app message triggers, pausing, and lifecycle events.

Functions

add_trigger async

add_trigger(key: str, value: str) -> None

Add a trigger that may cause an in-app message to display.

Parameters:

Name	Type	Description	Default
key	str	The trigger key.	required
value	str	The trigger value.	required

add_triggers async

add_triggers(triggers: dict[str, str]) -> None

Add multiple triggers.

Parameters:

Name	Type	Description	Default
triggers	dict[str, str]	A dictionary of trigger key-value pairs.	required

clear_triggers async

clear_triggers() -> None

Clear all triggers.

is_paused async

is_paused(timeout: float = 25) -> bool

Check if in-app messages are currently paused.

Returns:

Type	Description
bool	True if paused, False otherwise.

pause async

pause() -> None

Pause in-app messages.

remove_trigger async

remove_trigger(key: str) -> None

Remove a trigger.

Parameters:

Name	Type	Description	Default
key	str	The trigger key to remove.	required

remove_triggers async

remove_triggers(keys: list[str]) -> None

Remove multiple triggers.

Parameters:

Name	Type	Description	Default
keys	list[str]	A list of trigger keys to remove.	required

resume async

resume() -> None

Resume in-app messages.

set_paused async

set_paused(paused: bool) -> None

Pause or unpause in-app messages.

When paused, in-app messages will not be displayed even if triggers are met. Messages will be displayed when unpaused if triggers are still active.

Parameters:

Name	Type	Description	Default
paused	bool	True to pause, False to unpause.	required