getAddOnContext method

Future<AddOnContext> getAddOnContext(String courseId, String postId, { String? addOnToken, String? attachmentId, String? itemId, String? $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.

Request parameters:

courseId - Required. Identifier of the course.

postId - Optional. Deprecated, use item_id instead.

addOnToken - 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.

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

itemId - 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.

$fields - Selector specifying which fields to include in a partial response.

Completes with a AddOnContext.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<AddOnContext> getAddOnContext(
  core.String courseId,
  core.String postId, {
  core.String? addOnToken,
  core.String? attachmentId,
  core.String? itemId,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (addOnToken != null) 'addOnToken': [addOnToken],
    if (attachmentId != null) 'attachmentId': [attachmentId],
    if (itemId != null) 'itemId': [itemId],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/courses/' +
      commons.escapeVariable('$courseId') +
      '/posts/' +
      commons.escapeVariable('$postId') +
      '/addOnContext';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return AddOnContext.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}