Host Class Reference

The Host object represents the tool or application that created a session with OpenAssetIO, and wants to query or store information within a manager. More...

#include <Host.hpp>

Public Types
using	Ptr = HostPtr
using	ConstPtr = HostConstPtr

Public Member Functions
Host Information
Identifier	identifier () const
	Returns an identifier to uniquely identify the Host. More...
Str	displayName () const
	Returns a human readable name to be used to reference this specific host in user-facing messaging. More...
InfoDictionary	info ()
	Returns other information that may be useful about the host. More...

Static Public Member Functions
static HostPtr	make (hostApi::HostInterfacePtr hostInterface)
	Constructs a new Host wrapping the supplied host interface. More...

Detailed Description

The Host object represents the tool or application that created a session with OpenAssetIO, and wants to query or store information within a manager.

The Host provides a generalised API to query the identity of the caller of the API. In the future, this interface may be extended to allow retrieval of information about available documents as well as which entities are used within these documents.

Hosts should never be directly constructed by the Manager's implementation. Instead, the managerApi::HostSession class provided to all manager API entry points provides access to the current host through the HostSession.host method

Member Typedef Documentation

using ConstPtr = HostConstPtr

using Ptr = HostPtr

Member Function Documentation

Str displayName

(

)

const

Returns a human readable name to be used to reference this specific host in user-facing messaging.

For example:

"OpenAssetIO Test Host"

Identifier identifier

(

)

const

Returns an identifier to uniquely identify the Host.

The identifier will be different for each tool or application, but common to all versions of any one. The identifier will use only alpha-numeric characters and '.', '_' or '-', commonly in the form of a 'reverse-DNS' style string, for example:

"org.openassetio.test.host"

InfoDictionary info

(

)

Returns other information that may be useful about the host.

This can contain arbitrary key/value pairs. There should be no reliance on a specific key being supplied by all hosts. The information may be more generally useful for diagnostic or debugging purposes. For example:

{ 'version' : '1.1v3' }

static HostPtr make ( hostApi::HostInterfacePtr  hostInterface )

static

Constructs a new Host wrapping the supplied host interface.

---

The documentation for this class was generated from the following file:

• /src/src/openassetio-core/include/openassetio/managerApi/Host.hpp