google_classroom_api::Registration Class Reference

#include <registration.h>

Inheritance diagram for google_classroom_api::Registration:

Public Member Functions
	Registration (const Json::Value &storage)
	Registration (Json::Value *storage)
virtual	~Registration ()
const StringPiece	GetTypeName () const
bool	has_cloud_pubsub_topic () const
void	clear_cloud_pubsub_topic ()
const CloudPubsubTopic	get_cloud_pubsub_topic () const
CloudPubsubTopic	mutable_cloudPubsubTopic ()
bool	has_expiry_time () const
void	clear_expiry_time ()
const StringPiece	get_expiry_time () const
void	set_expiry_time (const StringPiece &value)
bool	has_feed () const
void	clear_feed ()
const Feed	get_feed () const
Feed	mutable_feed ()
bool	has_registration_id () const
void	clear_registration_id ()
const StringPiece	get_registration_id () const
void	set_registration_id (const StringPiece &value)

Static Public Member Functions
static Registration *	New ()

Detailed Description

An instruction to Classroom to send notifications from the feed to the provided destination.

Constructor & Destructor Documentation

Registration() [1/2]

google_classroom_api::Registration::Registration ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Registration() [2/2]

google_classroom_api::Registration::Registration ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Registration()

google_classroom_api::Registration::~Registration ( )

virtual

Standard destructor.

Member Function Documentation

clear_cloud_pubsub_topic()

void google_classroom_api::Registration::clear_cloud_pubsub_topic ( )

inline

Clears the 'cloudPubsubTopic' attribute.

clear_expiry_time()

void google_classroom_api::Registration::clear_expiry_time ( )

inline

Clears the 'expiryTime' attribute.

clear_feed()

void google_classroom_api::Registration::clear_feed ( )

inline

Clears the 'feed' attribute.

clear_registration_id()

void google_classroom_api::Registration::clear_registration_id ( )

inline

Clears the 'registrationId' attribute.

get_cloud_pubsub_topic()

const CloudPubsubTopic google_classroom_api::Registration::get_cloud_pubsub_topic

(

)

const

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

get_expiry_time()

const StringPiece google_classroom_api::Registration::get_expiry_time ( ) const

inline

Get the value of the 'expiryTime' attribute.

get_feed()

const Feed google_classroom_api::Registration::get_feed

(

)

const

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

get_registration_id()

const StringPiece google_classroom_api::Registration::get_registration_id ( ) const

inline

Get the value of the 'registrationId' attribute.

GetTypeName()

const StringPiece google_classroom_api::Registration::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::Registration

has_cloud_pubsub_topic()

bool google_classroom_api::Registration::has_cloud_pubsub_topic ( ) const

inline

Determine if the 'cloudPubsubTopic' attribute was set.

Returns

true if the 'cloudPubsubTopic' attribute was set.

has_expiry_time()

bool google_classroom_api::Registration::has_expiry_time ( ) const

inline

Determine if the 'expiryTime' attribute was set.

Returns

true if the 'expiryTime' attribute was set.

has_feed()

bool google_classroom_api::Registration::has_feed ( ) const

inline

Determine if the 'feed' attribute was set.

Returns

true if the 'feed' attribute was set.

has_registration_id()

bool google_classroom_api::Registration::has_registration_id ( ) const

inline

Determine if the 'registrationId' attribute was set.

Returns

true if the 'registrationId' attribute was set.

mutable_cloudPubsubTopic()

CloudPubsubTopic google_classroom_api::Registration::mutable_cloudPubsubTopic

(

)

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

The Cloud Pub/Sub topic that notifications are to be sent to.

Returns

The result can be modified to change the attribute value.

mutable_feed()

Feed google_classroom_api::Registration::mutable_feed

(

)

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

Specification for the class of notifications that Classroom should deliver to the destination.

Returns

The result can be modified to change the attribute value.

New()

Registration * google_classroom_api::Registration::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_expiry_time()

void google_classroom_api::Registration::set_expiry_time ( const StringPiece &  value )

inline

Change the 'expiryTime' attribute.

The time until which the Registration is effective.

This is a read-only field assigned by the server.

Parameters

[in]

value

The new value.

set_registration_id()

void google_classroom_api::Registration::set_registration_id ( const StringPiece &  value )

inline

Change the 'registrationId' attribute.

A server-generated unique identifier for this Registration.

Read-only.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/registration.h
• google/classroom_api/registration.cc