class UserProfile

Member values

Member name	Data type	Description
handle	UserProfileHandle	User handle (no need to set it with CreateUserProfile())
username	string	Username, which is used to connect to robot (or login via Web App)
firstname	string	User's first name
lastname	string	User's last name
application_data	string	Application data (reserved for use by Web App)

Member functions

Function name	Return type	Input type	Description
has_handle() const	bool	void	Returns true if handle is set.
handle()	const UserProfileHandle&	void	Returns the current value of handle. If handle is not set, returns a UserProfileHandle with none of its fields set (possibly handle::default_instance()).
mutable_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_handle() will return true and handle() will return a reference to the same instance of UserProfileHandle.
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	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 handle is NULL, the behavior is the same as calling clear_handle().
release_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_handle() will return false, and handle() will return the default value.
username()	const string&	void	Returns the current value of username. If username is not set, returns the empty string/empty bytes.
set_username()	void	const string&	Sets the value of username. After calling this, username() will return a copy of value.
set_username()	void	string&&	(C++11 and beyond): Sets the value of username, moving from the passed string. After calling this, username() will return a copy of value.
set_username()	void	const char*	Sets the value of username using a C-style null-terminated string. After calling this, username() will return a copy of value.
mutable_username()	string *	void	Returns a pointer to the mutable string object that stores username's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, username() will return whatever value is written into the given string.
clear_username()	void	void	Clears the value of username. After calling this, username() will return the empty string/empty bytes.
set_allocated_username()	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_username().
release_username()	string *	void	Releases the ownership of username and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and username() will return the empty string/empty bytes.
firstname()	const string&	void	Returns the current value of firstname. If firstname is not set, returns the empty string/empty bytes.
set_firstname()	void	const string&	Sets the value of firstname. After calling this, firstname() will return a copy of value.
set_firstname()	void	string&&	(C++11 and beyond): Sets the value of firstname, moving from the passed string. After calling this, firstname() will return a copy of value.
set_firstname()	void	const char*	Sets the value of firstname using a C-style null-terminated string. After calling this, firstname() will return a copy of value.
mutable_firstname()	string *	void	Returns a pointer to the mutable string object that stores firstname's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, firstname() will return whatever value is written into the given string.
clear_firstname()	void	void	Clears the value of firstname. After calling this, firstname() will return the empty string/empty bytes.
set_allocated_firstname()	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_firstname().
release_firstname()	string *	void	Releases the ownership of firstname and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and firstname() will return the empty string/empty bytes.
lastname()	const string&	void	Returns the current value of lastname. If lastname is not set, returns the empty string/empty bytes.
set_lastname()	void	const string&	Sets the value of lastname. After calling this, lastname() will return a copy of value.
set_lastname()	void	string&&	(C++11 and beyond): Sets the value of lastname, moving from the passed string. After calling this, lastname() will return a copy of value.
set_lastname()	void	const char*	Sets the value of lastname using a C-style null-terminated string. After calling this, lastname() will return a copy of value.
mutable_lastname()	string *	void	Returns a pointer to the mutable string object that stores lastname's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, lastname() will return whatever value is written into the given string.
clear_lastname()	void	void	Clears the value of lastname. After calling this, lastname() will return the empty string/empty bytes.
set_allocated_lastname()	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_lastname().
release_lastname()	string *	void	Releases the ownership of lastname and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and lastname() will return the empty string/empty bytes.
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++)