Module googleapis.classroom

ballerinax/googleapis.classroom Ballerina library

1.5.1

Overview

This is a generated connector for Google Classroom API v1 OpenAPI specification. Manages classes, rosters, and invitations in Google Classroom.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Google Classroom connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/googleapis.classroom module into the Ballerina project.

Copy
import ballerinax/googleapis.classroom;

Step 2: Create a new connector instance

Create a classroom:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.

Copy
classroom:ClientConfig clientConfig = {
    auth: {
        clientId: <CLIENT_ID>,
        clientSecret: <CLIENT_SECRET>,
        refreshUrl: <REFRESH_URL>,
        refreshToken: <REFRESH_TOKEN>
    }
};

classroom:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to return a list of courses that the requesting user is permitted to view, restricted to those that match the request using the connector.

    Return a list of courses

    Copy
    public function main() {
        classroom:ListCoursesResponse|error response = baseClient->listCourses();
        if (response is classroom:ListCoursesResponse) {
            log:printInfo(response.toString());
        } else {
            log:printError(response.message());
        }
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/googleapis.classroom;Copy

Metadata

Released date: 10 months ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 0


Weekly downloads


Source repository


Keywords

Education/Elearning
Cost/Free
Vendor/Google

Contributors

Other versions

See more...