Class CoursesResource.AnnouncementsResource.PatchRequest

Updates one or more fields of an announcement.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if the requested course or announcement does not exist
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Announcement>
ClassroomBaseServiceRequest<Announcement>
CoursesResource.AnnouncementsResource.PatchRequest
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 PatchRequest : ClassroomBaseServiceRequest<Announcement>, IClientServiceRequest<Announcement>, IClientServiceRequest

Constructors

PatchRequest(IClientService, Announcement, String, String)

Constructs a new Patch request.

Declaration
public PatchRequest(IClientService service, Announcement body, string courseId, string id)
Parameters
Type Name Description
IClientService service
Announcement body
System.String courseId
System.String id

Properties

CourseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Declaration
[RequestParameter("courseId", RequestParameterType.Path)]
public virtual string CourseId { get; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Announcement>.HttpMethod

Id

Identifier of the announcement.

Declaration
[RequestParameter("id", RequestParameterType.Path)]
public virtual string Id { get; }
Property Value
Type Description
System.String

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Announcement>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Announcement>.RestPath

UpdateMask

Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error will be returned.

The following fields may be specified by teachers:

  • text * state * scheduled_time
Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }
Property Value
Type Description
System.Object

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Announcement>.GetBody()

InitParameters()

Initializes Patch parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.Announcement>.InitParameters()

Implements