#include <user_profile.h>
Global information for a user.
◆ UserProfile() [1/2]
google_classroom_api::UserProfile::UserProfile |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ UserProfile() [2/2]
google_classroom_api::UserProfile::UserProfile |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~UserProfile()
google_classroom_api::UserProfile::~UserProfile |
( |
| ) |
|
|
virtual |
◆ clear_email_address()
void google_classroom_api::UserProfile::clear_email_address |
( |
| ) |
|
|
inline |
Clears the 'emailAddress
' attribute.
◆ clear_id()
void google_classroom_api::UserProfile::clear_id |
( |
| ) |
|
|
inline |
Clears the 'id
' attribute.
◆ clear_name()
void google_classroom_api::UserProfile::clear_name |
( |
| ) |
|
|
inline |
Clears the 'name
' attribute.
◆ clear_permissions()
void google_classroom_api::UserProfile::clear_permissions |
( |
| ) |
|
|
inline |
Clears the 'permissions
' attribute.
◆ clear_photo_url()
void google_classroom_api::UserProfile::clear_photo_url |
( |
| ) |
|
|
inline |
Clears the 'photoUrl
' attribute.
◆ clear_verified_teacher()
void google_classroom_api::UserProfile::clear_verified_teacher |
( |
| ) |
|
|
inline |
Clears the 'verifiedTeacher
' attribute.
◆ get_email_address()
const StringPiece google_classroom_api::UserProfile::get_email_address |
( |
| ) |
const |
|
inline |
Get the value of the 'emailAddress
' attribute.
◆ get_id()
const StringPiece google_classroom_api::UserProfile::get_id |
( |
| ) |
const |
|
inline |
Get the value of the 'id
' attribute.
◆ get_name()
const Name google_classroom_api::UserProfile::get_name |
( |
| ) |
const |
Get a reference to the value of the 'name
' attribute.
◆ get_permissions()
const client::JsonCppArray<GlobalPermission > google_classroom_api::UserProfile::get_permissions |
( |
| ) |
const |
Get a reference to the value of the 'permissions
' attribute.
◆ get_photo_url()
const StringPiece google_classroom_api::UserProfile::get_photo_url |
( |
| ) |
const |
|
inline |
Get the value of the 'photoUrl
' attribute.
◆ get_verified_teacher()
bool google_classroom_api::UserProfile::get_verified_teacher |
( |
| ) |
const |
|
inline |
Get the value of the 'verifiedTeacher
' attribute.
◆ GetTypeName()
const StringPiece google_classroom_api::UserProfile::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_email_address()
bool google_classroom_api::UserProfile::has_email_address |
( |
| ) |
const |
|
inline |
Determine if the 'emailAddress
' attribute was set.
- Returns
- true if the '
emailAddress
' attribute was set.
◆ has_id()
bool google_classroom_api::UserProfile::has_id |
( |
| ) |
const |
|
inline |
Determine if the 'id
' attribute was set.
- Returns
- true if the '
id
' attribute was set.
◆ has_name()
bool google_classroom_api::UserProfile::has_name |
( |
| ) |
const |
|
inline |
Determine if the 'name
' attribute was set.
- Returns
- true if the '
name
' attribute was set.
◆ has_permissions()
bool google_classroom_api::UserProfile::has_permissions |
( |
| ) |
const |
|
inline |
Determine if the 'permissions
' attribute was set.
- Returns
- true if the '
permissions
' attribute was set.
◆ has_photo_url()
bool google_classroom_api::UserProfile::has_photo_url |
( |
| ) |
const |
|
inline |
Determine if the 'photoUrl
' attribute was set.
- Returns
- true if the '
photoUrl
' attribute was set.
◆ has_verified_teacher()
bool google_classroom_api::UserProfile::has_verified_teacher |
( |
| ) |
const |
|
inline |
Determine if the 'verifiedTeacher
' attribute was set.
- Returns
- true if the '
verifiedTeacher
' attribute was set.
◆ mutable_name()
Name google_classroom_api::UserProfile::mutable_name |
( |
| ) |
|
Gets a reference to a mutable value of the 'name
' property.
Name of the user.
Read-only.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_permissions()
client::JsonCppArray<GlobalPermission > google_classroom_api::UserProfile::mutable_permissions |
( |
| ) |
|
Gets a reference to a mutable value of the 'permissions
' property.
Global permissions of the user.
Read-only.
- Returns
- The result can be modified to change the attribute value.
◆ New()
UserProfile * google_classroom_api::UserProfile::New |
( |
| ) |
|
|
static |
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_email_address()
void google_classroom_api::UserProfile::set_email_address |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'emailAddress
' attribute.
Email address of the user.
Read-only.
- Parameters
-
◆ set_id()
void google_classroom_api::UserProfile::set_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'id
' attribute.
Identifier of the user.
Read-only.
- Parameters
-
◆ set_photo_url()
void google_classroom_api::UserProfile::set_photo_url |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'photoUrl
' attribute.
URL of user's profile photo.
Read-only.
- Parameters
-
◆ set_verified_teacher()
void google_classroom_api::UserProfile::set_verified_teacher |
( |
bool |
value | ) |
|
|
inline |
Change the 'verifiedTeacher
' attribute.
Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false.
Read-only.
- Parameters
-
The documentation for this class was generated from the following files:
- google/classroom_api/user_profile.h
- google/classroom_api/user_profile.cc