Class CoursesResource.AliasesResource

The "aliases" collection of methods.

Inheritance

System.Object

CoursesResource.AliasesResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Classroom.v1

Assembly: Google.Apis.Classroom.v1.dll

Syntax

public class AliasesResource

Constructors

AliasesResource(IClientService)

Constructs a new resource.

Declaration

public AliasesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(CourseAlias, String)

Creates an alias for a course.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors.
• NOT_FOUND if the course does not exist. * ALREADY_EXISTS if the alias already exists. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).

Declaration

public virtual CoursesResource.AliasesResource.CreateRequest Create(CourseAlias body, string courseId)

Parameters

Type	Name	Description
CourseAlias	body	The body of the request.
System.String	courseId	Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.

Returns

Type	Description
CoursesResource.AliasesResource.CreateRequest

Delete(String, String)

Deletes an alias of a course.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to remove the alias or for access errors.
• NOT_FOUND if the alias does not exist. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).

Declaration

public virtual CoursesResource.AliasesResource.DeleteRequest Delete(string courseId, string alias)

Parameters

Type	Name	Description
System.String	courseId	Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
System.String	alias	Alias to delete. This may not be the Classroom-assigned identifier.

Returns

Type	Description
CoursesResource.AliasesResource.DeleteRequest

List(String)

Returns a list of aliases for a course.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to access the course or for access errors.
• NOT_FOUND if the course does not exist.

Declaration

public virtual CoursesResource.AliasesResource.ListRequest List(string courseId)

Parameters

Type	Name	Description
System.String	courseId	The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns

Type	Description
CoursesResource.AliasesResource.ListRequest