Overview

Plugin Interface

The plugin class should implement this interface. The methods are used to subscribe to events. Events available are listed here.

Example

Instantiate a plugin.

TypeScript

import { Plugin } from "@qatium/sdk/plugin";

class MyPlugin implements Plugin {
  run() {}
};

const myPlugin = new MyPlugin();

Python

from qatiumsdk import Plugin, sdk

class MyPlugin(Plugin):
  def run(self):
    sdk.ui.send_message("plugin developer")

init()

The function init is the entry point for the plugin code. It should be called with the plugin instance in order to run the plugin.

Method signature

TypeScript

init(plugin: Plugin): void;

Python

def init(plugin: Plugin) -> None

Parameters

• plugin: Plugin: A Plugin instance

Example

Initializes a plugin instance.

TypeScript

import { Plugin, init } from "@qatium/sdk/plugin";

class MyPlugin implements Plugin {
  run() {}
};

const myPlugin = new MyPlugin();

init(myPlugin);

Python

plugin/plugin.py

from qatiumsdk import Plugin, sdk

class MyPlugin(Plugin):
  def run(self):
    pass

plugin/__init__.py

from .plugin import MyPlugin
from qatiumsdk import init

init(MyPlugin())