新增及移除具有權限的記事協作者
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
記事的建立者即為該記事的擁有者。擁有者可以使用授予個別使用者或群組的權限,新增其他協作者。協作者將獲得記事的編輯權限。協作者也可以使用 API 撤銷權限。本頁說明如何使用權限新增及刪除協作者。
新增新增協作者的權限
以下範例說明如何使用使用者或群組的權限,在記事中新增協作者:
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();
}
撤銷權限以移除協作者
以下範例說明如何使用權限,從記事中移除所有協作者:
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();
}
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-03-11 (世界標準時間)。
[null,null,["上次更新時間:2025-03-11 (世界標準時間)。"],[],[],null,["# Add and remove note collaborators with permissions\n\nThe creator of a note is the owner of that note. The owner can add other\ncollaborators using permissions granted to individual users or groups.\nCollaborators gain edit access to the note. Collaborators can also have their\npermissions revoked using the API. This page explains how to add and delete\ncollaborators using permissions.\n\nAdd permissions to add collaborators\n------------------------------------\n\nThe following sample shows how to use permissions on a user or group to add\ncollaborators to a note: \n\n### REST\n\nCall\n[notes.permissions.batchCreate()](/workspace/keep/api/reference/rest/v1/notes.permissions/batchCreate)\nwith the parent note assigned the permission and `permission`. Note that the\nmember (user, group) can only be assigned the `WRITER` role.\n\n### Java\n\n /**\n * Grants write access to a user and to a Google group for the given note.\n *\n * @param note The note whose permissions will be updated.\n * @param userEmail Email address of the user that will be added to the permissions of the note.\n * @param groupEmail Email address of the Google group that will be added to the permissions of\n * the note.\n * @throws IOException\n * @return The response of the create permissions request.\n */\n private BatchCreatePermissionsResponse addPermissions(\n Note note, String userEmail, String groupEmail) throws IOException {\n String noteName = note.getName();\n CreatePermissionRequest userPermission =\n new CreatePermissionRequest()\n .setParent(noteName)\n .setPermission(new Permission().setEmail(userEmail).setRole(\"WRITER\"));\n\n CreatePermissionRequest groupPermission =\n new CreatePermissionRequest()\n .setParent(noteName)\n .setPermission(new Permission().setEmail(groupEmail).setRole(\"WRITER\"));\n\n BatchCreatePermissionsRequest batchCreatePermissionsRequest =\n new BatchCreatePermissionsRequest()\n .setRequests(Arrays.asList(userPermission, groupPermission));\n\n return keepService\n .notes()\n .permissions()\n .batchCreate(noteName, batchCreatePermissionsRequest)\n .execute();\n }\n\nRevoke permissions to remove collaborators\n------------------------------------------\n\nThe following sample shows how to use permissions to remove all collaborators\nfrom a note: \n\n### REST\n\nCall\n[notes.permissions.batchDelete()](/workspace/keep/api/reference/rest/v1/notes.permissions/batchDelete)\nwith the parent note assigned the permission and `permission`.\n\n### Java\n\n /**\n * Deletes all permissions of a given note excluding the owner. Owner of the note cannot be\n * removed from a note's permissions.\n *\n * @param note The note whose permissions will be deleted.\n * @throws IOException\n */\n private void deletePermissions(Note note) throws IOException {\n List\u003cPermission\u003e notePermissions =\n keepService.notes().get(note.getName()).execute().getPermissions();\n\n // List of users, groups or families that will be deleted from the permissions of the note.\n List\u003cString\u003e permissionsToDelete = new ArrayList\u003c\u003e();\n\n for (Permission permission : notePermissions) {\n // Note owner cannot be removed from the permissions of the note. Trying to remove the note\n // owner from the permissions will cause an exception.\n if (!permission.getRole().equals(\"OWNER\")) {\n permissionsToDelete.add(permission.getName());\n }\n }\n\n keepService\n .notes()\n .permissions()\n .batchDelete(\n note.getName(), new BatchDeletePermissionsRequest().setNames(permissionsToDelete))\n .execute();\n }"]]