Class CoursesResource.AnnouncementsResource.ListRequest

Returns a list of announcements that the requester is permitted to view. Course students may only view PUBLISHED announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListAnnouncementsResponse>
ClassroomBaseServiceRequest<ListAnnouncementsResponse>
CoursesResource.AnnouncementsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CoursesResource.AnnouncementsResource.ListRequest : ClassroomBaseServiceRequest<ListAnnouncementsResponse>, IClientServiceRequest<ListAnnouncementsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string courseId)
Parameters
Type Name Description
IClientService service
string courseId

Properties

AnnouncementStates

Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

Declaration
[RequestParameter("announcementStates", RequestParameterType.Query)]
public virtual CoursesResource.AnnouncementsResource.ListRequest.AnnouncementStatesEnum? AnnouncementStates { get; set; }
Property Value
Type Description
CoursesResource.AnnouncementsResource.ListRequest.AnnouncementStatesEnum?
Remarks

Use this property to set a single value for the parameter, or AnnouncementStatesList to set multiple values. Do not set both properties.

AnnouncementStatesList

Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

Declaration
[RequestParameter("announcementStates", RequestParameterType.Query)]
public virtual Repeatable<CoursesResource.AnnouncementsResource.ListRequest.AnnouncementStatesEnum> AnnouncementStatesList { get; set; }
Property Value
Type Description
Repeatable<CoursesResource.AnnouncementsResource.ListRequest.AnnouncementStatesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and AnnouncementStates.

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
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements