AZ::DocumentPropertyEditor::BoundAdapterMessage Struct Reference

#include <DocumentAdapter.h>

Public Member Functions
Dom::Value	operator() (const Dom::Value &parameters)
Dom::Value	MarshalToDom () const

Static Public Member Functions
static AZStd::optional< BoundAdapterMessage >	TryMarshalFromDom (const Dom::Value &value)

Public Attributes
DocumentAdapter *	m_adapter = nullptr
AZ::Name	m_messageName
Dom::Path	m_messageOrigin
Dom::Value	m_contextData

Static Public Attributes
static const AZ::Name	s_typeField
static constexpr AZStd::string_view	s_typeName = "BoundAdapterMessage"
static const AZ::Name	s_adapterField
static const AZ::Name	s_messageNameField
static const AZ::Name	s_messageOriginField
static const AZ::Name	s_contextDataField

Detailed Description

An adapter message bound to a given adapter, to be invoked as part of a CallbackAttribute. Used to store a message and all of the associated context as part of a DocumentAdapter.

See also

AdapterBuilder::AddMessageHandler

Member Function Documentation

MarshalToDom()

Dom::Value AZ::DocumentPropertyEditor::BoundAdapterMessage::MarshalToDom

(

)

const

Marshal this bound message to a DOM::Value. This is not a serializable DOM::Value, as m_adapter is stored as a pointer.

TryMarshalFromDom()

static AZStd::optional< BoundAdapterMessage > AZ::DocumentPropertyEditor::BoundAdapterMessage::TryMarshalFromDom ( const Dom::Value &  value )

static

Attempts to recreate a BoundAdapterMessage from a value marshalled via MarshalToDom. Returns the BoundAdapterMessage if successful.

---

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

• Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/DocumentAdapter.h