EditingContext

class EditingContextClient
Canonical

kortex_api.autogen.client_stubs.EditingContextClientRpc

__init__(router, namespace=None)

Constructs a EditingContextClient with an initialized RouterClient and an optional namespace.

Parameters

  • router (RouterClient) – RouterClient used for the communication

  • namespace (string) – Optional namespace on which to initialize the EditingContextClient (defaults to None)

IsAlive(timeoutMs: int = 1000)

Returns True if the Service Server is detected online before timeoutMs is expired, False otherwise.

Parameters

timeoutMs (unsigned int) – The maximum time to wait for an answer from the server

Return type

bool

SetEditingContext(context, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Add the editing context to the editing context stack
Parameters

  • context (Context) –

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

UnsetEditingContext(contextsessionidentifier, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Remove the editing context from the editing context stack
Parameters