class PasswordChange

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
handleUserProfileHandleUser handle
old_passwordstringCurrent password
new_passwordstringNew password

Member functions

Function nameReturn typeInput typeDescription
has_handle() constboolvoidReturns true if handle is set.
handle()const UserProfileHandle&voidReturns 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 *voidReturns 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()voidvoidClears the value of the field. After calling this, has_handle() will return false and handle() will return the default value.
set_allocated_handle()voidUserProfileHandle *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 *voidReleases 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.
old_password()const string&voidReturns the current value of old_password. If old_password is not set, returns the empty string/empty bytes.
set_old_password()voidconst string&Sets the value of old_password. After calling this, old_password() will return a copy of value.
set_old_password()voidstring&&(C++11 and beyond): Sets the value of old_password, moving from the passed string. After calling this, old_password() will return a copy of value.
set_old_password()voidconst char*Sets the value of old_password using a C-style null-terminated string. After calling this, old_password() will return a copy of value.
mutable_old_password()string *voidReturns a pointer to the mutable string object that stores old_password's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, old_password() will return whatever value is written into the given string.
clear_old_password()voidvoidClears the value of old_password. After calling this, old_password() will return the empty string/empty bytes.
set_allocated_old_password()voidstring*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_old_password().
release_old_password()string *voidReleases the ownership of old_password and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and old_password() will return the empty string/empty bytes.
new_password()const string&voidReturns the current value of new_password. If new_password is not set, returns the empty string/empty bytes.
set_new_password()voidconst string&Sets the value of new_password. After calling this, new_password() will return a copy of value.
set_new_password()voidstring&&(C++11 and beyond): Sets the value of new_password, moving from the passed string. After calling this, new_password() will return a copy of value.
set_new_password()voidconst char*Sets the value of new_password using a C-style null-terminated string. After calling this, new_password() will return a copy of value.
mutable_new_password()string *voidReturns a pointer to the mutable string object that stores new_password's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, new_password() will return whatever value is written into the given string.
clear_new_password()voidvoidClears the value of new_password. After calling this, new_password() will return the empty string/empty bytes.
set_allocated_new_password()voidstring*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_new_password().
release_new_password()string *voidReleases the ownership of new_password and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and new_password() will return the empty string/empty bytes.

Parent topic: Base (C++)