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

היוצר של הפתק הוא הבעלים שלו. הבעלים יכול להוסיף שותפים נוספים באמצעות הרשאות שהוקצו למשתמשים או לקבוצות ספציפיים. לשותפי העריכה תהיה גישת עריכה לפתק. אפשר גם לבטל את ההרשאות של שותפי העריכה באמצעות ה-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();
}