google_classroom_api::CourseAlias Class Reference

#include <course_alias.h>

Inheritance diagram for google_classroom_api::CourseAlias:

Public Member Functions
	CourseAlias (const Json::Value &storage)
	CourseAlias (Json::Value *storage)
virtual	~CourseAlias ()
const StringPiece	GetTypeName () const
bool	has_alias () const
void	clear_alias ()
const StringPiece	get_alias () const
void	set_alias (const StringPiece &value)

Static Public Member Functions
static CourseAlias *	New ()

Detailed Description

Alternative identifier for a course.

An alias uniquely identifies a course. It must be unique within one of the following scopes:

• domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.
• project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.

Constructor & Destructor Documentation

CourseAlias() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

CourseAlias() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~CourseAlias()

google_classroom_api::CourseAlias::~CourseAlias ( )

virtual

Standard destructor.

Member Function Documentation

clear_alias()

void google_classroom_api::CourseAlias::clear_alias ( )

inline

Clears the 'alias' attribute.

get_alias()

const StringPiece google_classroom_api::CourseAlias::get_alias ( ) const

inline

Get the value of the 'alias' attribute.

GetTypeName()

const StringPiece google_classroom_api::CourseAlias::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::CourseAlias

has_alias()

bool google_classroom_api::CourseAlias::has_alias ( ) const

inline

Determine if the 'alias' attribute was set.

Returns

true if the 'alias' attribute was set.

New()

CourseAlias * google_classroom_api::CourseAlias::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_alias()

void google_classroom_api::CourseAlias::set_alias ( const StringPiece &  value )

inline

Change the 'alias' attribute.

Alias string. The format of the string indicates the desired alias scoping.

• d: indicates a domain-scoped alias. Example: d:math_101
• p: indicates a project-scoped alias. Example: p:abc123

This field has a maximum length of 256 characters.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/course_alias.h
• google/classroom_api/course_alias.cc