Utility

class apsync.Icon

class apsync.Icon(icon_path: str)

class apsync.Icon(icon_path: str, color: str)

The icon of a folder or task in the Anchorpoint UI. To get the path to a built-in icon right click an icon in the icon picker menu.

Example

>>> icon = apsync.Icon("qrc:/icons/multimedia/old video camera.svg", "green")

property color: Optional[str]

typing.Optional[str]

Type

type

property path: Optional[str]

typing.Optional[str]

Type

type

class apsync.ApiVersion(major: int, minor: int, patch: int)

class apsync.ApiVersion(version: str)

The ApiVersion identifies the current version of the anchorpoint and apsync API version. Use the ApiVersion object to check for API compatibility, for example.

Examples

Get the current version of the Api

>>> apsync.get_api_version()
>>> 1.0.0

Check what version you are running

>>> if get_api_version() >= apsync.ApiVersion("1.0.2"):
>>>     print("We are running Anchorpoint 1.0.2 or greater")