Spreadsheet sharing
This section explains more about the sharing.
Documentation
Methods
Methods related to the spreadsheet sharing and users management and permissions.
| Method | Description |
|---|---|
| getUsers | Get all the users invited for a online spreadsheet. Jspreadsheet getUsers(): Promise<{ name: string, email: string, title: string, level: number, token: string, }> GET /api/:guid/users |
| setUsers | Add a new user to the spreadsheet. @param users[].email - user email. @param users[].level - user level. Jspreadsheet setUsers(users: { email: string; level: number }[]): Promise<{ email: string; token: string }[]> POST /api/:guid/users |
| updateUsers | Update a user from the spreadsheet. @param users[].email - user email. @param users[].level - user level. Jspreadsheet updateUsers(users: { email: string; level: number }[]): Promise<void> POST /api/:guid/users/update |
| deleteUsers | Delete one or more users from the spreadsheet. @param users - emails of users that should be removed. `Jspreadsheet deleteUsers(users: string |
Examples
Invitations
Get all users invited for a online spreadsheet.
import { Client } from "@intrasheets/client";
// Create a new client
const client = new Client({
// API Server
baseUrl: "http://localhost:8009/api",
// Your authentication token
token: "eyJhbGciOiJIUzUxMiIsInR5cCJ9.eyJkb21haW4iOiJsb2NhbGhvc3Q6ODAPQSJ9.Xr2Ir2-zEc_tqV5y6i",
});
// Spreadsheet Guid
const guid = '79b45919-c751-4e2b-a49a-6c1286e2fc03';
// Get the spreadsheet instance
const spreadsheet = client.getSpreadsheet(guid);
// Request data
spreadsheet.getUsers().then((data) => {
// List of users invited for a spreadsheet
console.log(data);
});