fiftyone.server.events.initialize

module documentation

(source)

FiftyOne Server events initialization.

Class	`InitializedListener`	Undocumented
Function	`handle_app_initializer`	Handle an App initialization request
Function	`handle_dataset_change`	Handle a dataset change request.
Function	`handle_group_id`	Handle a group id.
Function	`handle_group_slice`	Handle a group slice.
Function	`handle_sample_id`	Handle a sample id.
Function	`handle_saved_view`	Handle a saved view slug.
Function	`handle_workspace`	Handle a workspace slug request.
Async Function	`initialize_listener`	Initialize a state listener.
Function	`initialize_listener_sync`	Synchronously initializer a listener

def handle_app_initializer(subscription: str, initializer: AppInitializer): (source) ¶

Handle an App initialization request

Parameters
subscription:`str`	a subscription id
initializer:`AppInitializer`	an app initializer
Returns
`None` or a coroutine

def handle_dataset_change(state: fos.StateDescription, initializer: AppInitializer): (source) ¶

Handle a dataset change request.

Parameters
state:`fos.StateDescription`	the state description
initializer:`AppInitializer`	an app initializer

def handle_group_id(state: fos.StateDescription, group_id: str | None = None): (source) ¶

Handle a group id.

Parameters
state:`fos.StateDescription`	the state description
group_id:`None`	an optional group ID
Returns
True/False indicating if a state update event should be dispatched

def handle_group_slice(state: fos.StateDescription, group_slice: str | None = None): (source) ¶

Handle a group slice.

Parameters
state:`fos.StateDescription`	the state description
group_slice:`None`	an optional group slice
Returns
True/False indicating if a state update event should be dispatched

def handle_sample_id(state: fos.StateDescription, sample_id: str | None = None): (source) ¶

Handle a sample id.

Parameters
state:`fos.StateDescription`	the state description
sample_id:`None`	an optional sample ID
Returns
True/False indicating if a state update event should be dispatched

def handle_saved_view(state: fos.StateDescription, slug: str | None = None): (source) ¶

Handle a saved view slug.

Parameters
state:`fos.StateDescription`	the state description
slug:`None`	an optional slug
Returns
True/False indicating if a state update event should be dispatched

def handle_workspace(state: fos.StateDescription, slug: str | None = None): (source) ¶

Handle a workspace slug request.

Parameters
state:`fos.StateDescription`	the state description
slug:`None`	an optional slug
Returns
True/False indicating if a state update event should be dispatched

async def initialize_listener(payload: ListenPayload): (source) ¶

Initialize a state listener.

Parameters
payload:`ListenPayload`	a `fiftyone.core.session.events.ListenPayload`
Returns
an `InitializedListener`

def initialize_listener_sync(payload: ListenPayload): (source) ¶

Synchronously initializer a listener

Parameters
payload:`ListenPayload`	a `fiftyone.core.session.events.ListenPayload`