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

#include <channel.h>

Inheritance diagram for google_drive_api::Channel:

Public Member Functions

 Channel (const Json::Value &storage)
 
 Channel (Json::Value *storage)
 
virtual ~Channel ()
 
const StringPiece GetTypeName () const
 
bool has_address () const
 
void clear_address ()
 
const StringPiece get_address () const
 
void set_address (const StringPiece &value)
 
bool has_expiration () const
 
void clear_expiration ()
 
int64 get_expiration () const
 
void set_expiration (int64 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_params () const
 
void clear_params ()
 
const client::JsonCppAssociativeArray< string > get_params () const
 
client::JsonCppAssociativeArray< string > mutable_params ()
 
bool has_payload () const
 
void clear_payload ()
 
bool get_payload () const
 
void set_payload (bool value)
 
bool has_resource_id () const
 
void clear_resource_id ()
 
const StringPiece get_resource_id () const
 
void set_resource_id (const StringPiece &value)
 
bool has_resource_uri () const
 
void clear_resource_uri ()
 
const StringPiece get_resource_uri () const
 
void set_resource_uri (const StringPiece &value)
 
bool has_token () const
 
void clear_token ()
 
const StringPiece get_token () const
 
void set_token (const StringPiece &value)
 
bool has_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 

Static Public Member Functions

static ChannelNew ()
 

Detailed Description

An notification channel used to watch for resource changes.

Constructor & Destructor Documentation

◆ Channel() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Channel() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Channel()

google_drive_api::Channel::~Channel ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_address()

void google_drive_api::Channel::clear_address ( )
inline

Clears the 'address' attribute.

◆ clear_expiration()

void google_drive_api::Channel::clear_expiration ( )
inline

Clears the 'expiration' attribute.

◆ clear_id()

void google_drive_api::Channel::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_drive_api::Channel::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_params()

void google_drive_api::Channel::clear_params ( )
inline

Clears the 'params' attribute.

◆ clear_payload()

void google_drive_api::Channel::clear_payload ( )
inline

Clears the 'payload' attribute.

◆ clear_resource_id()

void google_drive_api::Channel::clear_resource_id ( )
inline

Clears the 'resourceId' attribute.

◆ clear_resource_uri()

void google_drive_api::Channel::clear_resource_uri ( )
inline

Clears the 'resourceUri' attribute.

◆ clear_token()

void google_drive_api::Channel::clear_token ( )
inline

Clears the 'token' attribute.

◆ clear_type()

void google_drive_api::Channel::clear_type ( )
inline

Clears the 'type' attribute.

◆ get_address()

const StringPiece google_drive_api::Channel::get_address ( ) const
inline

Get the value of the 'address' attribute.

◆ get_expiration()

int64 google_drive_api::Channel::get_expiration ( ) const
inline

Get the value of the 'expiration' attribute.

◆ get_id()

const StringPiece google_drive_api::Channel::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_params()

const client::JsonCppAssociativeArray<string > google_drive_api::Channel::get_params ( ) const
inline

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

◆ get_payload()

bool google_drive_api::Channel::get_payload ( ) const
inline

Get the value of the 'payload' attribute.

◆ get_resource_id()

const StringPiece google_drive_api::Channel::get_resource_id ( ) const
inline

Get the value of the 'resourceId' attribute.

◆ get_resource_uri()

const StringPiece google_drive_api::Channel::get_resource_uri ( ) const
inline

Get the value of the 'resourceUri' attribute.

◆ get_token()

const StringPiece google_drive_api::Channel::get_token ( ) const
inline

Get the value of the 'token' attribute.

◆ get_type()

const StringPiece google_drive_api::Channel::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_drive_api::Channel

◆ has_address()

bool google_drive_api::Channel::has_address ( ) const
inline

Determine if the 'address' attribute was set.

Returns
true if the 'address' attribute was set.

◆ has_expiration()

bool google_drive_api::Channel::has_expiration ( ) const
inline

Determine if the 'expiration' attribute was set.

Returns
true if the 'expiration' attribute was set.

◆ has_id()

bool google_drive_api::Channel::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::Channel::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_params()

bool google_drive_api::Channel::has_params ( ) const
inline

Determine if the 'params' attribute was set.

Returns
true if the 'params' attribute was set.

◆ has_payload()

bool google_drive_api::Channel::has_payload ( ) const
inline

Determine if the 'payload' attribute was set.

Returns
true if the 'payload' attribute was set.

◆ has_resource_id()

bool google_drive_api::Channel::has_resource_id ( ) const
inline

Determine if the 'resourceId' attribute was set.

Returns
true if the 'resourceId' attribute was set.

◆ has_resource_uri()

bool google_drive_api::Channel::has_resource_uri ( ) const
inline

Determine if the 'resourceUri' attribute was set.

Returns
true if the 'resourceUri' attribute was set.

◆ has_token()

bool google_drive_api::Channel::has_token ( ) const
inline

Determine if the 'token' attribute was set.

Returns
true if the 'token' attribute was set.

◆ has_type()

bool google_drive_api::Channel::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ mutable_params()

client::JsonCppAssociativeArray<string > google_drive_api::Channel::mutable_params ( )
inline

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

Additional parameters controlling delivery channel behavior. Optional.

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

◆ New()

Channel * google_drive_api::Channel::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_address()

void google_drive_api::Channel::set_address ( const StringPiece &  value)
inline

Change the 'address' attribute.

The address where notifications are delivered for this channel.

Parameters
[in]valueThe new value.

◆ set_expiration()

void google_drive_api::Channel::set_expiration ( int64  value)
inline

Change the 'expiration' attribute.

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Parameters
[in]valueThe new value.

◆ set_id()

void google_drive_api::Channel::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

A UUID or similar unique string that identifies this channel.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Parameters
[in]valueThe new value.

◆ set_payload()

void google_drive_api::Channel::set_payload ( bool  value)
inline

Change the 'payload' attribute.

A Boolean value to indicate whether payload is wanted. Optional.

Parameters
[in]valueThe new value.

◆ set_resource_id()

void google_drive_api::Channel::set_resource_id ( const StringPiece &  value)
inline

Change the 'resourceId' attribute.

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Parameters
[in]valueThe new value.

◆ set_resource_uri()

void google_drive_api::Channel::set_resource_uri ( const StringPiece &  value)
inline

Change the 'resourceUri' attribute.

A version-specific identifier for the watched resource.

Parameters
[in]valueThe new value.

◆ set_token()

void google_drive_api::Channel::set_token ( const StringPiece &  value)
inline

Change the 'token' attribute.

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Parameters
[in]valueThe new value.

◆ set_type()

void google_drive_api::Channel::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

The type of delivery mechanism used for this channel.

Parameters
[in]valueThe new value.

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