openassetio::v1::constants Namespace Reference

Constants used throughout the OpenAssetIO API. More...

Variables
Info dictionary field names.
Bare strings should never be used to help protect against inconsistencies and future changes.
constexpr std::string_view	kInfoKey_SmallIcon = "smallIcon"
constexpr std::string_view	kInfoKey_Icon = "icon"
constexpr std::string_view	kInfoKey_IsPython = "isPython"
	Indicate that the callee is written primarily in Python. More...
constexpr std::string_view	kInfoKey_EntityReferencesMatchPrefix
	Common prefix for all entity references of a particular manager. More...

Detailed Description

Constants used throughout the OpenAssetIO API.

Variable Documentation

constexpr std::string_view kInfoKey_EntityReferencesMatchPrefix

inline

Initial value:

=
    "entityReferencesMatchPrefix"

Common prefix for all entity references of a particular manager.

This field may be used by the API to optimize queries to isEntityReferenceString in situations where bridging languages, etc. can be expensive (particularly in the case of python plug-ins called from multi-threaded C++).

constexpr std::string_view kInfoKey_Icon = "icon"

inline

constexpr std::string_view kInfoKey_IsPython = "isPython"

inline

Indicate that the callee is written primarily in Python.

OpenAssetIO is a mostly seamless dual-language library, but for some access patterns it may be necessary for callers to be aware that the callee is written in Python to ensure correct behaviour.

See also

HostInterface.info.

constexpr std::string_view kInfoKey_SmallIcon = "smallIcon"

inline