Struct google_classroom1::CourseAnnouncementListCall

pub struct CourseAnnouncementListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

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.

A builder for the announcements.list method supported by a course resource. It is not used directly, but through a CourseMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.courses().announcements_list("courseId")
             .page_token("et")
             .page_size(-70)
             .order_by("aliquyam")
             .add_announcement_states("sea")
             .doit();

Methods

impl<'a, C, A> CourseAnnouncementListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, ListAnnouncementsResponse)>

Perform the operation you have build so far.

pub fn course_id(self, new_value: &str) -> CourseAnnouncementListCall<'a, C, A>

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

Sets the course id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn page_token(self, new_value: &str) -> CourseAnnouncementListCall<'a, C, A>

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.

Sets the page token query property to the given value.

pub fn page_size(self, new_value: i32) -> CourseAnnouncementListCall<'a, C, A>

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.

Sets the page size query property to the given value.

pub fn order_by(self, new_value: &str) -> CourseAnnouncementListCall<'a, C, A>

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

Sets the order by query property to the given value.

pub fn add_announcement_states(
    self,
    new_value: &str
) -> CourseAnnouncementListCall<'a, C, A>

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

Append the given value to the announcement states query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> CourseAnnouncementListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> CourseAnnouncementListCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> CourseAnnouncementListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::AnnouncementReadonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for CourseAnnouncementListCall<'a, C, A>