M_Dialogue::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	EventTextMessage (std::string const &Text, M_Dialogue::DialogueCategoryOptionalType const &MessageType)
virtual void	ReportInputChoice (M_Common::ObjectIdType const &KeyDialogueId, M_Dialogue::InputChoiceType const &InputChoice, bool IsRemoved)

Detailed Description

Client interface. Contains callback operations from the dialogue service to the client.

Constructor & Destructor Documentation

~IClient()

M_Dialogue::IClient::~IClient ( )

virtual

Member Function Documentation

EventTextMessage()

void M_Dialogue::IClient::EventTextMessage ( std::string const &  Text, M_Dialogue::DialogueCategoryOptionalType const &  MessageType  )

virtual

Reports an arbitrary text message, e.g. for logging purposes.

Parameters

Text	Text.
MessageType	Message/log type.

ReportInputChoice()

void M_Dialogue::IClient::ReportInputChoice ( M_Common::ObjectIdType const &  KeyDialogueId, M_Dialogue::InputChoiceType const &  InputChoice, bool  IsRemoved  )

virtual

Reports the dialogue for required input to the current action being performed.

Parameters

KeyDialogueId	Identifier of the currently report input choice.
InputChoice	Input choice.
IsRemoved	Indicates if the dialogue is no longer available (true) or actively awaiting input (false). The service should provide the report with IsRemoved = true when a CmdSelectInputChoice() has been accepted from the client. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.