Application programming interfaces for notebook settings
Application programming interfaces (API) are provided for notebook settings, for example, classroom notebook settings. The APIs allow for a teacher or other user of a class notebook to manage permissions to the class notebooks, and particularly allow for fine control over parts of the class notebook through a class notebook application. An API for generating a guest access link is provided. APIs for creating permission groups for a collaboration space are provided. A post permission API is provided that creates or updates the permission for a section group. A get permission API is provided that retrieves permission information of a section group. A delete permission API is provided that removes permission for a user of a section group.
1. A method for managing permissions to content in a notebook comprising:
receiving, at a notebook system, a request for a guest access link to a specified user's content in a section group of a notebook, the specified user's content in the section group being a portion of content within the notebook;
communicating with a file management system to get or create a guest link to the specified user's content in the section group;
upon receiving the guest link, creating, at the notebook system, the guest access link by appending an online rendering flag to the guest link so a third party can have a live view; and
providing the guest access link to a source of the request, the guest access link providing access to only the portion of content within the notebook without providing permissions to any other content in the notebook.
2. The method of claim 1 , further comprising:
in response to receiving a request to revoke the guest access link to the specified user's content in the section group, communicating with the file management system to remove the guest link.
3. The method of claim 1 , wherein communicating with the file management system comprises:
requesting to get the guest link to the specified user's content in the section group; and
receiving the guest link or an indication that the guest link does not exist.
4. The method of claim 3 , further comprising:
in response to receiving the indication that the guest link does not exist, requesting to create the guest link; and
receiving the guest link.
5. The method of claim 1 , wherein communicating with the file management system includes communicating a section group identifier.
6. The method of claim 1 , wherein the guest access link grants a read-only permission.
7. The method of claim 1 , wherein the guest access link grants an editing permission.
8. A method for managing permissions in a notebook comprising a plurality of section groups including a collaboration section group, a content library section group, and a plurality of user-specific section groups, the method comprising:
in response to receiving, at a notebook system, a request to post a permission for a section group of the notebook, communicating with a file management system to create or update the permission for the section group,
the request comprising a section group identifier, a user identifier, and a type of the permission, and
the section group of the notebook being a portion of the notebook;
in response to receiving, at the notebook system, a request to get a permission for the section group of the notebook, communicating with the file management system to receive the permission for the section group,
the request comprising the section group identifier and a permission object, and
the section group of the notebook being the portion of the notebook; and
in response to receiving, at the notebook system, a request to delete a permission for the section group of the notebook, communicating with the file management system to delete the permission for the section group,
the request comprising the section group identifier and a permission identifier, and
the section group of the notebook being the portion of the notebook.
9. The method of claim 8 , wherein the permission object comprises a user display name, a permission identifier, a uniform resource locator of the permission object, a user identifier, and a type of the permission.
10. The method of claim 8 , wherein communicating with a file management system to create or update the permission for the section group comprises sending a post request to the file management system.
11. The method of claim 8 , wherein communicating with the file management system to receive the permission for the section group comprises sending a get request to the file management system.
12. The method of claim 8 , wherein communicating with the file management system to delete the permission for the section group comprises sending a delete request to the file management system.
13. One or more computer readable storage media having instructions stored thereon that when executed by a processing system direct the processing system of a notebook system to at least:
in response to receiving, at the notebook system, a request for a guest access link to a specified user's content in a section group of a notebook, communicate with a file management system to get or create a guest link to the specified user's content in the section group, the specified user's content in the section group being a portion of content within the notebook;
upon receiving the guest link, create, at the notebook system, the guest access link by appending an online rendering flag to the guest link so a third party can have a live view; and
provide the guest access link to a source of the request, the guest access link providing access to only the portion of content within the notebook without providing permissions to any other content in the notebook.
14. The media of claim 13 , wherein the instructions further direct the processing system to at least:
in response to receiving a request to revoke the guest access link to the specified user's content in the section group, communicate with the file management system to remove the guest link.
15. The media of claim 13 , wherein instructions that direct the system to communicate with the file management system, direct the system to at least:
request the file management system to get the guest link to the specified user's content in the section group; and
receive the guest link or an indication that the guest link does not exist.
16. The media of claim 15 , wherein the instructions that direct the system to communicate with the file management system further direct the processing system to at least:
in response to receiving the indication that the guest link does not exist, request the file management system to create the guest link; and
receive the guest link.
17. The media of claim 13 , wherein the communication with the file management system includes communicating a section group identifier.
18. The media of claim 13 , wherein the guest access link grants a read-only permission.
19. The media of claim 13 , wherein the guest access link grants an editing permission.
20. The media of claim 13 , wherein access to the guest access link does not require authentication.