class SequenceInfoNotification

February 26, 2020 · View on GitHub

Member values

Member name	Data type	Description
event_identifier	uint32	Sequence event type
sequence_handle	SequenceHandle	Handle of the sequence that this event refers to
task_index	uint32	Task index
group_identifier	uint32	This field is deprecated and unused. Use task_index instead.
timestamp	Timestamp	Event timestamp
user_handle	UserProfileHandle	User that caused the sequence event
abort_details	uint32	Details if event_identifier is equal to ABORT
connection	Connection	Connection that caused the sequence event

Member functions

Function name	Return type	Input type	Description
event_identifier() const	uint32	void	Returns the current value of event_identifier. If the event_identifier is not set, returns 0.
set_event_identifier()	void	uint32	Sets the value of event_identifier. After calling this, event_identifier() will return value.
clear_event_identifier()	void	void	Clears the value of event_identifier. After calling this, event_identifier() will return the empty string/empty bytes.
has_sequence_handle() const	bool	void	Returns true if sequence_handle is set.
sequence_handle()	const SequenceHandle&	void	Returns the current value of sequence_handle. If sequence_handle is not set, returns a SequenceHandle with none of its fields set (possibly sequence_handle::default_instance()).
mutable_sequence_handle()	SequenceHandle *	void	Returns a pointer to the mutable SequenceHandle object that stores the field's value. If the field was not set prior to the call, then the returned SequenceHandle will have none of its fields set (i.e. it will be identical to a newly-allocated SequenceHandle). After calling this, has_sequence_handle() will return true and sequence_handle() will return a reference to the same instance of SequenceHandle.
clear_sequence_handle()	void	void	Clears the value of the field. After calling this, has_sequence_handle() will return false and sequence_handle() will return the default value.
set_allocated_sequence_handle()	void	SequenceHandle *	Sets the SequenceHandle object to the field and frees the previous field value if it exists. If the SequenceHandle pointer is not NULL, the message takes ownership of the allocated SequenceHandle object and has_ SequenceHandle() will return true. Otherwise, if the sequence_handle is NULL, the behavior is the same as calling clear_sequence_handle().
release_sequence_handle()	SequenceHandle *	void	Releases the ownership of the field and returns the pointer of the SequenceHandle object. After calling this, caller takes the ownership of the allocated SequenceHandle object, has_sequence_handle() will return false, and sequence_handle() will return the default value.
task_index()	uint32	void	Returns the current value of task_index. If the task_index is not set, returns 0.
set_task_index()	void	uint32	Sets the value of task_index. After calling this, task_index() will return value.
clear_task_index()	void	void	Clears the value of task_index. After calling this, task_index() will return 0.
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_timestamp() const	bool	void	Returns true if timestamp is set.
timestamp()	const Timestamp&	void	Returns the current value of timestamp. If timestamp is not set, returns a Timestamp with none of its fields set (possibly timestamp::default_instance()).
mutable_timestamp()	Timestamp *	void	Returns a pointer to the mutable Timestamp object that stores the field's value. If the field was not set prior to the call, then the returned Timestamp will have none of its fields set (i.e. it will be identical to a newly-allocated Timestamp). After calling this, has_timestamp() will return true and timestamp() will return a reference to the same instance of Timestamp.
clear_timestamp()	void	void	Clears the value of the field. After calling this, has_timestamp() will return false and timestamp() will return the default value.
set_allocated_timestamp()	void	Timestamp *	Sets the Timestamp object to the field and frees the previous field value if it exists. If the Timestamp pointer is not NULL, the message takes ownership of the allocated Timestamp object and has_ Timestamp() will return true. Otherwise, if the timestamp is NULL, the behavior is the same as calling clear_timestamp().
release_timestamp()	Timestamp *	void	Releases the ownership of the field and returns the pointer of the Timestamp object. After calling this, caller takes the ownership of the allocated Timestamp object, has_timestamp() will return false, and timestamp() will return the default value.
has_user_handle() const	bool	void	Returns true if user_handle is set.
user_handle()	const UserProfileHandle&	void	Returns the current value of user_handle. If user_handle is not set, returns a UserProfileHandle with none of its fields set (possibly user_handle::default_instance()).
mutable_user_handle()	UserProfileHandle *	void	Returns a pointer to the mutable UserProfileHandle object that stores the field's value. If the field was not set prior to the call, then the returned UserProfileHandle will have none of its fields set (i.e. it will be identical to a newly-allocated UserProfileHandle). After calling this, has_user_handle() will return true and user_handle() will return a reference to the same instance of UserProfileHandle.
clear_user_handle()	void	void	Clears the value of the field. After calling this, has_user_handle() will return false and user_handle() will return the default value.
set_allocated_user_handle()	void	UserProfileHandle *	Sets the UserProfileHandle object to the field and frees the previous field value if it exists. If the UserProfileHandle pointer is not NULL, the message takes ownership of the allocated UserProfileHandle object and has_ UserProfileHandle() will return true. Otherwise, if the user_handle is NULL, the behavior is the same as calling clear_user_handle().
release_user_handle()	UserProfileHandle *	void	Releases the ownership of the field and returns the pointer of the UserProfileHandle object. After calling this, caller takes the ownership of the allocated UserProfileHandle object, has_user_handle() will return false, and user_handle() will return the default value.
abort_details() const	uint32	void	Returns the current value of abort_details. If the abort_details is not set, returns 0.
set_abort_details()	void	uint32	Sets the value of abort_details. After calling this, abort_details() will return value.
clear_abort_details()	void	void	Clears the value of abort_details. After calling this, abort_details() will return the empty string/empty bytes.
has_connection() const	bool	void	Returns true if connection is set.
connection()	const Connection&	void	Returns the current value of connection. If connection is not set, returns a Connection with none of its fields set (possibly connection::default_instance()).
mutable_connection()	Connection *	void	Returns a pointer to the mutable Connection object that stores the field's value. If the field was not set prior to the call, then the returned Connection will have none of its fields set (i.e. it will be identical to a newly-allocated Connection). After calling this, has_connection() will return true and connection() will return a reference to the same instance of Connection.
clear_connection()	void	void	Clears the value of the field. After calling this, has_connection() will return false and connection() will return the default value.
set_allocated_connection()	void	Connection *	Sets the Connection object to the field and frees the previous field value if it exists. If the Connection pointer is not NULL, the message takes ownership of the allocated Connection object and has_ Connection() will return true. Otherwise, if the connection is NULL, the behavior is the same as calling clear_connection().
release_connection()	Connection *	void	Releases the ownership of the field and returns the pointer of the Connection object. After calling this, caller takes the ownership of the allocated Connection object, has_connection() will return false, and connection() will return the default value.

Parent topic: Base (C++)