#include <permission.h>

Inheritance diagram for google_drive_api::Permission:

Classes
class	PermissionPermissionDetails

class	PermissionTeamDrivePermissionDetails

Public Member Functions
	Permission (const Json::Value &storage)

	Permission (Json::Value *storage)

virtual	~Permission ()

const StringPiece	GetTypeName () const

bool	has_additional_roles () const

void	clear_additional_roles ()

const client::JsonCppArray< string >	get_additional_roles () const

client::JsonCppArray< string >	mutable_additionalRoles ()

bool	has_auth_key () const

void	clear_auth_key ()

const StringPiece	get_auth_key () const

void	set_auth_key (const StringPiece &value)

bool	has_deleted () const

void	clear_deleted ()

bool	get_deleted () const

void	set_deleted (bool value)

bool	has_domain () const

void	clear_domain ()

const StringPiece	get_domain () const

void	set_domain (const StringPiece &value)

bool	has_email_address () const

void	clear_email_address ()

const StringPiece	get_email_address () const

void	set_email_address (const StringPiece &value)

bool	has_etag () const

void	clear_etag ()

const StringPiece	get_etag () const

void	set_etag (const StringPiece &value)

bool	has_expiration_date () const

void	clear_expiration_date ()

client::DateTime	get_expiration_date () const

void	set_expiration_date (client::DateTime value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_permission_details () const

void	clear_permission_details ()

const client::JsonCppArray< PermissionPermissionDetails >	get_permission_details () const

client::JsonCppArray< PermissionPermissionDetails >	mutable_permissionDetails ()

bool	has_photo_link () const

void	clear_photo_link ()

const StringPiece	get_photo_link () const

void	set_photo_link (const StringPiece &value)

bool	has_role () const

void	clear_role ()

const StringPiece	get_role () const

void	set_role (const StringPiece &value)

bool	has_self_link () const

void	clear_self_link ()

const StringPiece	get_self_link () const

void	set_self_link (const StringPiece &value)

bool	has_team_drive_permission_details () const

void	clear_team_drive_permission_details ()

const client::JsonCppArray< PermissionTeamDrivePermissionDetails >	get_team_drive_permission_details () const

client::JsonCppArray< PermissionTeamDrivePermissionDetails >	mutable_teamDrivePermissionDetails ()

bool	has_type () const

void	clear_type ()

const StringPiece	get_type () const

void	set_type (const StringPiece &value)

bool	has_value () const

void	clear_value ()

const StringPiece	get_value () const

void	set_value (const StringPiece &value)

bool	has_with_link () const

void	clear_with_link ()

bool	get_with_link () const

void	set_with_link (bool value)

Static Public Member Functions
static Permission *	New ()

Detailed Description

A permission for a file.

Constructor & Destructor Documentation

◆ Permission() [1/2]

google_drive_api::Permission::Permission ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Permission() [2/2]

google_drive_api::Permission::Permission ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Permission()

google_drive_api::Permission::~Permission ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_additional_roles()

void google_drive_api::Permission::clear_additional_roles ( )

inline

Clears the 'additionalRoles' attribute.

◆ clear_auth_key()

void google_drive_api::Permission::clear_auth_key ( )

inline

Clears the 'authKey' attribute.

◆ clear_deleted()

void google_drive_api::Permission::clear_deleted ( )

inline

Clears the 'deleted' attribute.

◆ clear_domain()

void google_drive_api::Permission::clear_domain ( )

inline

Clears the 'domain' attribute.

◆ clear_email_address()

void google_drive_api::Permission::clear_email_address ( )

inline

Clears the 'emailAddress' attribute.

◆ clear_etag()

void google_drive_api::Permission::clear_etag ( )

inline

Clears the 'etag' attribute.

◆ clear_expiration_date()

void google_drive_api::Permission::clear_expiration_date ( )

inline

Clears the 'expirationDate' attribute.

◆ clear_id()

void google_drive_api::Permission::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_drive_api::Permission::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_drive_api::Permission::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_permission_details()

void google_drive_api::Permission::clear_permission_details ( )

inline

Clears the 'permissionDetails' attribute.

◆ clear_photo_link()

void google_drive_api::Permission::clear_photo_link ( )

inline

Clears the 'photoLink' attribute.

◆ clear_role()

void google_drive_api::Permission::clear_role ( )

inline

Clears the 'role' attribute.

◆ clear_self_link()

void google_drive_api::Permission::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_team_drive_permission_details()

void google_drive_api::Permission::clear_team_drive_permission_details ( )

inline

Clears the 'teamDrivePermissionDetails' attribute.

◆ clear_type()

void google_drive_api::Permission::clear_type ( )

inline

Clears the 'type' attribute.

◆ clear_value()

void google_drive_api::Permission::clear_value ( )

inline

Clears the 'value' attribute.

◆ clear_with_link()

void google_drive_api::Permission::clear_with_link ( )

inline

Clears the 'withLink' attribute.

◆ get_additional_roles()

const client::JsonCppArray<string > google_drive_api::Permission::get_additional_roles ( ) const

inline

Get a reference to the value of the 'additionalRoles' attribute.

◆ get_auth_key()

const StringPiece google_drive_api::Permission::get_auth_key ( ) const

inline

Get the value of the 'authKey' attribute.

◆ get_deleted()

bool google_drive_api::Permission::get_deleted ( ) const

inline

Get the value of the 'deleted' attribute.

◆ get_domain()

const StringPiece google_drive_api::Permission::get_domain ( ) const

inline

Get the value of the 'domain' attribute.

◆ get_email_address()

const StringPiece google_drive_api::Permission::get_email_address ( ) const

inline

Get the value of the 'emailAddress' attribute.

◆ get_etag()

const StringPiece google_drive_api::Permission::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

◆ get_expiration_date()

client::DateTime google_drive_api::Permission::get_expiration_date ( ) const

inline

Get the value of the 'expirationDate' attribute.

◆ get_id()

const StringPiece google_drive_api::Permission::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_drive_api::Permission::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_drive_api::Permission::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_permission_details()

const client::JsonCppArray<PermissionPermissionDetails > google_drive_api::Permission::get_permission_details ( ) const

inline

Get a reference to the value of the 'permissionDetails' attribute.

◆ get_photo_link()

const StringPiece google_drive_api::Permission::get_photo_link ( ) const

inline

Get the value of the 'photoLink' attribute.

◆ get_role()

const StringPiece google_drive_api::Permission::get_role ( ) const

inline

Get the value of the 'role' attribute.

◆ get_self_link()

const StringPiece google_drive_api::Permission::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_team_drive_permission_details()

const client::JsonCppArray<PermissionTeamDrivePermissionDetails > google_drive_api::Permission::get_team_drive_permission_details ( ) const

inline

Get a reference to the value of the 'teamDrivePermissionDetails' attribute.

◆ get_type()

const StringPiece google_drive_api::Permission::get_type ( ) const

inline

Get the value of the 'type' attribute.

◆ get_value()

const StringPiece google_drive_api::Permission::get_value ( ) const

inline

Get the value of the 'value' attribute.

◆ get_with_link()

bool google_drive_api::Permission::get_with_link ( ) const

inline

Get the value of the 'withLink' attribute.

◆ GetTypeName()

const StringPiece google_drive_api::Permission::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_drive_api::Permission

◆ has_additional_roles()

bool google_drive_api::Permission::has_additional_roles ( ) const

inline

Determine if the 'additionalRoles' attribute was set.

Returns: true if the 'additionalRoles' attribute was set.

◆ has_auth_key()

bool google_drive_api::Permission::has_auth_key ( ) const

inline

Determine if the 'authKey' attribute was set.

Returns: true if the 'authKey' attribute was set.

◆ has_deleted()

bool google_drive_api::Permission::has_deleted ( ) const

inline

Determine if the 'deleted' attribute was set.

Returns: true if the 'deleted' attribute was set.

◆ has_domain()

bool google_drive_api::Permission::has_domain ( ) const

inline

Determine if the 'domain' attribute was set.

Returns: true if the 'domain' attribute was set.

◆ has_email_address()

bool google_drive_api::Permission::has_email_address ( ) const

inline

Determine if the 'emailAddress' attribute was set.

Returns: true if the 'emailAddress' attribute was set.

◆ has_etag()

bool google_drive_api::Permission::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns: true if the 'etag' attribute was set.

◆ has_expiration_date()

bool google_drive_api::Permission::has_expiration_date ( ) const

inline

Determine if the 'expirationDate' attribute was set.

Returns: true if the 'expirationDate' attribute was set.

◆ has_id()

bool google_drive_api::Permission::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_kind()

bool google_drive_api::Permission::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_name()

bool google_drive_api::Permission::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_permission_details()

bool google_drive_api::Permission::has_permission_details ( ) const

inline

Determine if the 'permissionDetails' attribute was set.

Returns: true if the 'permissionDetails' attribute was set.

◆ has_photo_link()

bool google_drive_api::Permission::has_photo_link ( ) const

inline

Determine if the 'photoLink' attribute was set.

Returns: true if the 'photoLink' attribute was set.

◆ has_role()

bool google_drive_api::Permission::has_role ( ) const

inline

Determine if the 'role' attribute was set.

Returns: true if the 'role' attribute was set.

◆ has_self_link()

bool google_drive_api::Permission::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns: true if the 'selfLink' attribute was set.

◆ has_team_drive_permission_details()

bool google_drive_api::Permission::has_team_drive_permission_details ( ) const

inline

Determine if the 'teamDrivePermissionDetails' attribute was set.

Returns: true if the 'teamDrivePermissionDetails' attribute was set.

◆ has_type()

bool google_drive_api::Permission::has_type ( ) const

inline

Determine if the 'type' attribute was set.

Returns: true if the 'type' attribute was set.

◆ has_value()

bool google_drive_api::Permission::has_value ( ) const

inline

Determine if the 'value' attribute was set.

Returns: true if the 'value' attribute was set.

◆ has_with_link()

bool google_drive_api::Permission::has_with_link ( ) const

inline

Determine if the 'withLink' attribute was set.

Returns: true if the 'withLink' attribute was set.

◆ mutable_additionalRoles()

client::JsonCppArray<string > google_drive_api::Permission::mutable_additionalRoles ( )

inline

Gets a reference to a mutable value of the 'additionalRoles' property.

Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.

Returns: The result can be modified to change the attribute value.

◆ mutable_permissionDetails()

client::JsonCppArray<PermissionPermissionDetails > google_drive_api::Permission::mutable_permissionDetails ( )

inline

Gets a reference to a mutable value of the 'permissionDetails' property.

Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

Returns: The result can be modified to change the attribute value.

◆ mutable_teamDrivePermissionDetails()

client::JsonCppArray<PermissionTeamDrivePermissionDetails > google_drive_api::Permission::mutable_teamDrivePermissionDetails ( )

inline

Gets a reference to a mutable value of the 'teamDrivePermissionDetails' property.

Deprecated:

Deprecated - use permissionDetails instead.

Returns: The result can be modified to change the attribute value.

◆ New()

Permission * google_drive_api::Permission::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_auth_key()

void google_drive_api::Permission::set_auth_key ( const StringPiece & value )

inline

Change the 'authKey' attribute.

Deprecated:

Deprecated.

Parameters

[in] value The new value.

◆ set_deleted()

void google_drive_api::Permission::set_deleted ( bool value )

inline

Change the 'deleted' attribute.

Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

Parameters

[in] value The new value.

◆ set_domain()

void google_drive_api::Permission::set_domain ( const StringPiece & value )

inline

Change the 'domain' attribute.

The domain name of the entity this permission refers to. This is an output- only field which is present when the permission type is user, group or domain.

Parameters

[in] value The new value.

◆ set_email_address()

void google_drive_api::Permission::set_email_address ( const StringPiece & value )

inline

Change the 'emailAddress' attribute.

The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.

Parameters

[in] value The new value.

◆ set_etag()

void google_drive_api::Permission::set_etag ( const StringPiece & value )

inline

Change the 'etag' attribute.

The ETag of the permission.

Parameters

[in] value The new value.

◆ set_expiration_date()

void google_drive_api::Permission::set_expiration_date ( client::DateTime value )

inline

Change the 'expirationDate' attribute.

The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:

They can only be set on user and group permissions
The date must be in the future
The date cannot be more than a year in the future
The date can only be set on drive.permissions.update or drive.permissions.patch requests.

Parameters

[in] value The new value.

◆ set_id()

void google_drive_api::Permission::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.

Parameters

[in] value The new value.

◆ set_kind()

void google_drive_api::Permission::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

This is always drive::permission.

Parameters

[in] value The new value.

◆ set_name()

void google_drive_api::Permission::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

The name for this permission.

Parameters

[in] value The new value.

◆ set_photo_link()

void google_drive_api::Permission::set_photo_link ( const StringPiece & value )

inline

Change the 'photoLink' attribute.

A link to the profile photo, if available.

Parameters

[in] value The new value.

◆ set_role()

void google_drive_api::Permission::set_role ( const StringPiece & value )

inline

Change the 'role' attribute.

The primary role for this user. While new values may be supported in the future, the following are currently allowed:

owner
organizer
fileOrganizer
writer
reader.

Parameters

[in] value The new value.

◆ set_self_link()

void google_drive_api::Permission::set_self_link ( const StringPiece & value )

inline

Change the 'selfLink' attribute.

A link back to this permission.

Parameters

[in] value The new value.

◆ set_type()

void google_drive_api::Permission::set_type ( const StringPiece & value )

inline

Change the 'type' attribute.

The account type. Allowed values are:

user
group
domain
anyone.

Parameters

[in] value The new value.

◆ set_value()

void google_drive_api::Permission::set_value ( const StringPiece & value )

inline

Change the 'value' attribute.

The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.

Parameters

[in] value The new value.

◆ set_with_link()

void google_drive_api::Permission::set_with_link ( bool value )

inline

Change the 'withLink' attribute.

Whether the link is required for this permission.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/drive_api/permission.h
google/drive_api/permission.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Permission() [1/2]

◆ Permission() [2/2]

◆ ~Permission()

Member Function Documentation

◆ clear_additional_roles()

◆ clear_auth_key()

◆ clear_deleted()

◆ clear_domain()

◆ clear_email_address()

◆ clear_etag()

◆ clear_expiration_date()

◆ clear_id()

◆ clear_kind()

◆ clear_name()

◆ clear_permission_details()

◆ clear_photo_link()

◆ clear_role()

◆ clear_self_link()

◆ clear_team_drive_permission_details()

◆ clear_type()

◆ clear_value()

◆ clear_with_link()

◆ get_additional_roles()

◆ get_auth_key()

◆ get_deleted()

◆ get_domain()

◆ get_email_address()

◆ get_etag()

◆ get_expiration_date()

◆ get_id()

◆ get_kind()

◆ get_name()

◆ get_permission_details()

◆ get_photo_link()

◆ get_role()

◆ get_self_link()

◆ get_team_drive_permission_details()

◆ get_type()

◆ get_value()

◆ get_with_link()

◆ GetTypeName()

◆ has_additional_roles()

◆ has_auth_key()

◆ has_deleted()

◆ has_domain()

◆ has_email_address()

◆ has_etag()

◆ has_expiration_date()

◆ has_id()

◆ has_kind()

◆ has_name()

◆ has_permission_details()

◆ has_photo_link()

◆ has_role()

◆ has_self_link()

◆ has_team_drive_permission_details()

◆ has_type()

◆ has_value()

◆ has_with_link()

◆ mutable_additionalRoles()

◆ mutable_permissionDetails()

◆ mutable_teamDrivePermissionDetails()

◆ New()

◆ set_auth_key()

◆ set_deleted()

◆ set_domain()

◆ set_email_address()

◆ set_etag()

◆ set_expiration_date()

◆ set_id()

◆ set_kind()

◆ set_name()

◆ set_photo_link()

◆ set_role()

◆ set_self_link()