הוספה והסרה של שותפי עריכה בהערות עם הרשאות

יוצר ההערה הוא הבעלים של אותה הערה. הבעלים יכולים להוסיף שותפי עריכה אחרים באמצעות הרשאות שהוענקו למשתמשים או לקבוצות. שותפי עריכה יכולים לקבל גישת עריכה להערה. שותפי עריכה יכולים גם לבטל את ההרשאות שלהם באמצעות ה-API. בדף זה מוסבר איך להוסיף ולמחוק שותפי עריכה באמצעות הרשאות.

הוספת הרשאות להוספת שותפי עריכה

הדוגמה הבאה ממחישה איך להשתמש בהרשאות של משתמש או קבוצה כדי להוסיף שותפי עריכה להערה:

REST

מפעילים את הפקודה notes.permissions.batchCreate(), כאשר הערה ההורה מקצה את ההרשאה ו-permission. הערה: אפשר להקצות לחבר הקבוצה (משתמש, קבוצה) רק את התפקיד WRITER.

Java

/**
 * Grants write access to a user and to a Google group for the given note.
 *
 * @param note The note whose permissions will be updated.
 * @param userEmail Email address of the user that will be added to the permissions of the note.
 * @param groupEmail Email address of the Google group that will be added to the permissions of
 *     the note.
 * @throws IOException
 * @return The response of the create permissions request.
 */
private BatchCreatePermissionsResponse addPermissions(
    Note note, String userEmail, String groupEmail) throws IOException {
  String noteName = note.getName();
  CreatePermissionRequest userPermission =
      new CreatePermissionRequest()
          .setParent(noteName)
          .setPermission(new Permission().setEmail(userEmail).setRole("WRITER"));

  CreatePermissionRequest groupPermission =
      new CreatePermissionRequest()
          .setParent(noteName)
          .setPermission(new Permission().setEmail(groupEmail).setRole("WRITER"));

  BatchCreatePermissionsRequest batchCreatePermissionsRequest =
      new BatchCreatePermissionsRequest()
          .setRequests(Arrays.asList(userPermission, groupPermission));

  return keepService
      .notes()
      .permissions()
      .batchCreate(noteName, batchCreatePermissionsRequest)
      .execute();
}

ביטול ההרשאות להסרת שותפי עריכה

הדוגמה הבאה ממחישה איך להשתמש בהרשאות כדי להסיר את כל שותפי העריכה מהערה:

REST

מפעילים את הפקודה notes.permissions.batchDelete(), שבה מוקצית ההרשאה ואז permission.

Java

/**
 * Deletes all permissions of a given note excluding the owner. Owner of the note cannot be
 * removed from a note's permissions.
 *
 * @param note The note whose permissions will be deleted.
 * @throws IOException
 */
private void deletePermissions(Note note) throws IOException {
  List<Permission> notePermissions =
      keepService.notes().get(note.getName()).execute().getPermissions();

  // List of users, groups or families that will be deleted from the permissions of the note.
  List<String> permissionsToDelete = new ArrayList<>();

  for (Permission permission : notePermissions) {
    // Note owner cannot be removed from the permissions of the note. Trying to remove the note
    // owner from the permissions will cause an exception.
    if (!permission.getRole().equals("OWNER")) {
      permissionsToDelete.add(permission.getName());
    }
  }

  keepService
      .notes()
      .permissions()
      .batchDelete(
          note.getName(), new BatchDeletePermissionsRequest().setNames(permissionsToDelete))
      .execute();
}