SequenceTask.md

class SequenceTask

Member values

Member name	Data type	Description
group_identifier	uint32	This field is deprecated and unused. Use task_index in the SequenceTaskHandle instead.
action	Action	Specifies the action to execute
application_data	string	Application data (reserved for use by Web App)

Member functions

Function name	Return type	Input type	Description
group_identifier()	uint32	void	Returns the current value of group_identifier. If the group_identifier is not set, returns 0.
set_group_identifier()	void	uint32	Sets the value of group_identifier. After calling this, group_identifier() will return value.
clear_group_identifier()	void	void	Clears the value of group_identifier. After calling this, group_identifier() will return 0.
has_action() const	bool	void	Returns true if action is set.
action()	const Action&	void	Returns the current value of action. If action is not set, returns a Action with none of its fields set (possibly action::default_instance()).
mutable_action()	Action *	void	Returns a pointer to the mutable Action object that stores the field's value. If the field was not set prior to the call, then the returned Action will have none of its fields set (i.e. it will be identical to a newly-allocated Action). After calling this, has_action() will return true and action() will return a reference to the same instance of Action.
clear_action()	void	void	Clears the value of the field. After calling this, has_action() will return false and action() will return the default value.
set_allocated_action()	void	Action *	Sets the Action object to the field and frees the previous field value if it exists. If the Action pointer is not NULL, the message takes ownership of the allocated Action object and has_ Action() will return true. Otherwise, if the action is NULL, the behavior is the same as calling clear_action().
release_action()	Action *	void	Releases the ownership of the field and returns the pointer of the Action object. After calling this, caller takes the ownership of the allocated Action object, has_action() will return false, and action() will return the default value.
application_data()	const string&	void	Returns the current value of application_data. If application_data is not set, returns the empty string/empty bytes.
set_application_data()	void	const string&	Sets the value of application_data. After calling this, application_data() will return a copy of value.
set_application_data()	void	string&&	(C++11 and beyond): Sets the value of application_data, moving from the passed string. After calling this, application_data() will return a copy of value.
set_application_data()	void	const char*	Sets the value of application_data using a C-style null-terminated string. After calling this, application_data() will return a copy of value.
mutable_application_data()	string *	void	Returns a pointer to the mutable string object that stores application_data's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, application_data() will return whatever value is written into the given string.
clear_application_data()	void	void	Clears the value of application_data. After calling this, application_data() will return the empty string/empty bytes.
set_allocated_application_data()	void	string*	Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_application_data().
release_application_data()	string *	void	Releases the ownership of application_data and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and application_data() will return the empty string/empty bytes.

Parent topic: Base (C++)