Interface CommentsCollection

interface CommentsCollection {
    create(
        resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment,
        fileId: string,
        optionalArgs: { fields: string },
    ): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment;
    get(
        fileId: string,
        commentId: string,
    ): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment;
    get(
        fileId: string,
        commentId: string,
        optionalArgs: Record<string, any>,
    ): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment;
    list(fileId: string): GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList;
    list(
        fileId: string,
        optionalArgs: Record<string, any>,
    ): GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList;
    remove(fileId: string, commentId: string): void;
    update(
        resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment,
        fileId: string,
        commentId: string,
    ): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment;
}

Index

Methods

create get list remove update

Methods

create

create(
    resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment,
    fileId: string,
    optionalArgs: { fields: string },
): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
Creates a comment on a file.
Parameters
- resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- fileId: string
  
  The ID of the file.
- optionalArgs: { fields: string }
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1487

get

get(
fileId: string,
commentId: string,
): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
Gets a comment by ID.
Parameters
- fileId: string
  
  The ID of the file.
- commentId: string
  
  The ID of the comment.
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1495
get(
    fileId: string,
    commentId: string,
    optionalArgs: Record<string, any>,
): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
Gets a comment by ID.
Parameters
- fileId: string
  
  The ID of the file.
- commentId: string
  
  The ID of the comment.
- optionalArgs: Record<string, any>
  
  Optional arguments.
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1503

list

list(fileId: string): GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList
Lists a file's comments.
Parameters
- fileId: string
  
  The ID of the file.
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1510
list(
fileId: string,
optionalArgs: Record<string, any>,
): GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList
Lists a file's comments.
Parameters
- fileId: string
  
  The ID of the file.
- optionalArgs: Record<string, any>
  
  Optional arguments.
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.CommentList
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1514

remove

remove(fileId: string, commentId: string): void
Deletes a comment.
Parameters
- fileId: string
  
  The ID of the file.
- commentId: string
  
  The ID of the comment.
Returns void
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1521

update

update(
    resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment,
    fileId: string,
    commentId: string,
): GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
Updates a comment with patch semantics.
Parameters
- resource: GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- fileId: string
  
  The ID of the file.
- commentId: string
  
  The ID of the comment.
Returns GoogleAppsScript.Drive_v3.Drive.V3.Schema.Comment
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/apis/drive_v3.d.ts:1525