Definition

Provides data for the method_name_completed event.

class prompt_event_args : public xtd::event_args

Public Member Functions
bool	cancelled () const noexcept
	Gets a value indicating whether an asynchronous operation has been canceled. More...

std::optional< std::reference_wrapper< const xtd::system_exception > >	error () const noexcept
	Gets a value indicating which error occurred during an asynchronous operation. More...

const xtd::speech::synthesis::prompt &	prompt () const noexcept
	Gets the prompt associated with the event. More...

std::any	user_state () const noexcept
	Gets the unique identifier for the asynchronous task. More...

Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class. More...

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...

virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data. More...

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Member Function Documentation

bool xtd::speech::synthesis::prompt_event_args::cancelled ( ) const

inlinenoexcept

Gets a value indicating whether an asynchronous operation has been canceled.

Returns: true if the background operation has been canceled; otherwise false. The default is false.

std::optional<std::reference_wrapper<const xtd::system_exception> > xtd::speech::synthesis::prompt_event_args::error ( ) const

inlinenoexcept

Gets a value indicating which error occurred during an asynchronous operation.

Returns: An xtd::system_exception instance, if an error occurred during an asynchronous operation; otherwise std::nullopt.

const xtd::speech::synthesis::prompt& xtd::speech::synthesis::prompt_event_args::prompt ( ) const

inlinenoexcept

Gets the prompt associated with the event.

std::any xtd::speech::synthesis::prompt_event_args::user_state ( ) const

inlinenoexcept

Gets the unique identifier for the asynchronous task.

Returns: An object reference that uniquely identifies the asynchronous task.

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