Struct CourseAnnouncementGetAddOnContextCall 

pub struct CourseAnnouncementGetAddOnContextCall<'a, C>
where
    C: 'a,
{ /* private fields */ }

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user’s role whenever the add-on is opened in an iframe. This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

A builder for the announcements.getAddOnContext 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_get_add_on_context("courseId", "itemId")
             .post_id("erat")
             .attachment_id("sed")
             .add_on_token("duo")
             .doit().await;

Implementations

impl<'a, C> CourseAnnouncementGetAddOnContextCall<'a, C>

where C: Connector,

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

Perform the operation you have build so far.

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

Required. Identifier of the course.

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 item_id( self, new_value: &str, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.

Sets the item 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 post_id( self, new_value: &str, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

Optional. Deprecated, use item_id instead.

Sets the post id query property to the given value.

pub fn attachment_id( self, new_value: &str, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.

Sets the attachment id query property to the given value.

pub fn add_on_token( self, new_value: &str, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on’s URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.

Sets the add on token query property to the given value.

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

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, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

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

• $.xgafv (query-string) - V1 error format.
• access_token (query-string) - OAuth access token.
• alt (query-string) - Data format for response.
• callback (query-string) - JSONP
• fields (query-string) - Selector specifying which fields to include in a partial response.
• 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.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
• upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

pub fn add_scope<St>( self, scope: St, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

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

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

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.

pub fn add_scopes<I, St>( self, scopes: I, ) -> CourseAnnouncementGetAddOnContextCall<'a, C>

where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

pub fn clear_scopes(self) -> CourseAnnouncementGetAddOnContextCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations

impl<'a, C> CallBuilder for CourseAnnouncementGetAddOnContextCall<'a, C>