drive  v2
Public Member Functions | Static Public Member Functions | List of all members
google_drive_api::FileList Class Reference

#include <file_list.h>

Inheritance diagram for google_drive_api::FileList:

Public Member Functions

 FileList (const Json::Value &storage)
 
 FileList (Json::Value *storage)
 
virtual ~FileList ()
 
const StringPiece GetTypeName () const
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_incomplete_search () const
 
void clear_incomplete_search ()
 
bool get_incomplete_search () const
 
void set_incomplete_search (bool value)
 
bool has_items () const
 
void clear_items ()
 
const client::JsonCppArray< Fileget_items () const
 
client::JsonCppArray< Filemutable_items ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_next_link () const
 
void clear_next_link ()
 
const StringPiece get_next_link () const
 
void set_next_link (const StringPiece &value)
 
bool has_next_page_token () const
 
void clear_next_page_token ()
 
const StringPiece get_next_page_token () const
 
void set_next_page_token (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)
 

Static Public Member Functions

static FileListNew ()
 

Detailed Description

A list of files.

Constructor & Destructor Documentation

◆ FileList() [1/2]

google_drive_api::FileList::FileList ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ FileList() [2/2]

google_drive_api::FileList::FileList ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~FileList()

google_drive_api::FileList::~FileList ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_etag()

void google_drive_api::FileList::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_incomplete_search()

void google_drive_api::FileList::clear_incomplete_search ( )
inline

Clears the 'incompleteSearch' attribute.

◆ clear_items()

void google_drive_api::FileList::clear_items ( )
inline

Clears the 'items' attribute.

◆ clear_kind()

void google_drive_api::FileList::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_next_link()

void google_drive_api::FileList::clear_next_link ( )
inline

Clears the 'nextLink' attribute.

◆ clear_next_page_token()

void google_drive_api::FileList::clear_next_page_token ( )
inline

Clears the 'nextPageToken' attribute.

◆ clear_self_link()

void google_drive_api::FileList::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ get_etag()

const StringPiece google_drive_api::FileList::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_incomplete_search()

bool google_drive_api::FileList::get_incomplete_search ( ) const
inline

Get the value of the 'incompleteSearch' attribute.

◆ get_items()

const client::JsonCppArray<File > google_drive_api::FileList::get_items ( ) const

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

◆ get_kind()

const StringPiece google_drive_api::FileList::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_next_link()

const StringPiece google_drive_api::FileList::get_next_link ( ) const
inline

Get the value of the 'nextLink' attribute.

◆ get_next_page_token()

const StringPiece google_drive_api::FileList::get_next_page_token ( ) const
inline

Get the value of the 'nextPageToken' attribute.

◆ get_self_link()

const StringPiece google_drive_api::FileList::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ GetTypeName()

const StringPiece google_drive_api::FileList::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_drive_api::FileList

◆ has_etag()

bool google_drive_api::FileList::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_incomplete_search()

bool google_drive_api::FileList::has_incomplete_search ( ) const
inline

Determine if the 'incompleteSearch' attribute was set.

Returns
true if the 'incompleteSearch' attribute was set.

◆ has_items()

bool google_drive_api::FileList::has_items ( ) const
inline

Determine if the 'items' attribute was set.

Returns
true if the 'items' attribute was set.

◆ has_kind()

bool google_drive_api::FileList::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_next_link()

bool google_drive_api::FileList::has_next_link ( ) const
inline

Determine if the 'nextLink' attribute was set.

Returns
true if the 'nextLink' attribute was set.

◆ has_next_page_token()

bool google_drive_api::FileList::has_next_page_token ( ) const
inline

Determine if the 'nextPageToken' attribute was set.

Returns
true if the 'nextPageToken' attribute was set.

◆ has_self_link()

bool google_drive_api::FileList::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ mutable_items()

client::JsonCppArray<File > google_drive_api::FileList::mutable_items ( )

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

The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

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

◆ New()

FileList * google_drive_api::FileList::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_drive_api::FileList::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

The ETag of the list.

Parameters
[in]valueThe new value.

◆ set_incomplete_search()

void google_drive_api::FileList::set_incomplete_search ( bool  value)
inline

Change the 'incompleteSearch' attribute.

Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive".

Parameters
[in]valueThe new value.

◆ set_kind()

void google_drive_api::FileList::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

This is always drive::fileList.

Parameters
[in]valueThe new value.

◆ set_next_link()

void google_drive_api::FileList::set_next_link ( const StringPiece &  value)
inline

Change the 'nextLink' attribute.

A link to the next page of files.

Parameters
[in]valueThe new value.

◆ set_next_page_token()

void google_drive_api::FileList::set_next_page_token ( const StringPiece &  value)
inline

Change the 'nextPageToken' attribute.

The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_drive_api::FileList::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

A link back to this list.

Parameters
[in]valueThe new value.

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