Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 2.62 KB

ActionExecutionState.md

File metadata and controls

25 lines (19 loc) · 2.62 KB

class ActionExecutionState

Member values

Member name Data type Description
action_event uint32 Action event type
handle ActionHandle Identifies the action for which this event occured

Member functions

Function name Return type Input type Description
action_event() const uint32 void Returns the current value of action_event. If the action_event is not set, returns 0.
set_action_event() void uint32 Sets the value of action_event. After calling this, action_event() will return value.
clear_action_event() void void Clears the value of action_event. After calling this, action_event() will return the empty string/empty bytes.
has_handle() const bool void Returns true if handle is set.
handle() const ActionHandle& void Returns the current value of handle. If handle is not set, returns a ActionHandle with none of its fields set (possibly handle::default_instance()).
mutable_handle() ActionHandle * void Returns a pointer to the mutable ActionHandle object that stores the field's value. If the field was not set prior to the call, then the returned ActionHandle will have none of its fields set (i.e. it will be identical to a newly-allocated ActionHandle). After calling this, has_handle() will return true and handle() will return a reference to the same instance of ActionHandle.
clear_handle() void void Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value.
set_allocated_handle() void ActionHandle * Sets the ActionHandle object to the field and frees the previous field value if it exists. If the ActionHandle pointer is not NULL, the message takes ownership of the allocated ActionHandle object and has_ ActionHandle() will return true. Otherwise, if the handle is NULL, the behavior is the same as calling clear_handle().
release_handle() ActionHandle * void Releases the ownership of the field and returns the pointer of the ActionHandle object. After calling this, caller takes the ownership of the allocated ActionHandle object, has_handle() will return false, and handle() will return the default value.

Parent topic: Base (C++)