JoinWithSessionLinkWindow

class omni.kit.widget.live_session_management_ui.JoinWithSessionLinkWindow(

on_ok_button_cb: Callable[[str], None],

)

Bases: object

A modal dialog window for joining live sessions using a session link.

This window provides a user interface for entering or pasting a session link to join a live collaboration session. It validates the session link format, displays error messages for invalid links, and triggers a callback when the user confirms joining.

Parameters:

on_ok_button_cb (Callable[[str], None]) – Callback function called when user presses the JOIN button or Enter key. The callback receives the validated session link as a string parameter.

Methods

__init__(on_ok_button_cb)	Initializes a window for joining live sessions using session links.
destroy()	Cleans up resources and hides the window.
focus_field()	Focuses the session link input field.

Attributes

current_session_link	Gets the current session link value from the input field.
visible	Gets the current window visibility state.

__init__(

on_ok_button_cb: Callable[[str], None],

) → None

Initializes a window for joining live sessions using session links.

destroy()

Cleans up resources and hides the window.

async focus_field()

Focuses the session link input field.

property current_session_link

Gets the current session link value from the input field.

Returns:

The current session link value.

Return type:

str

property visible

Gets the current window visibility state.

Returns:

True if window is visible, False otherwise.

Return type:

bool