Drive API . replies

close()

Close httplib2 connections.

delete(fileId, commentId, replyId)

Deletes a reply.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  replyId: string, The ID of the reply. (required)

get(fileId, commentId, replyId, includeDeleted=None)

Gets a reply.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  replyId: string, The ID of the reply. (required)
  includeDeleted: boolean, If set, this will succeed when retrieving a deleted reply.

Returns:
  An object of the form:

    { # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}

insert(fileId, commentId, body=None)

Creates a new reply to the given comment.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}


Returns:
  An object of the form:

    { # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}

list(fileId, commentId, includeDeleted=None, maxResults=None, pageToken=None)

Lists all of the replies to a comment.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.
  maxResults: integer, The maximum number of replies to include in the response, used for paging.
  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

Returns:
  An object of the form:

    { # A list of replies to a comment on a file in Google Drive.
  "items": [ # The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
    { # A comment on a file in Google Drive.
      "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
        "displayName": "A String", # A plain text displayable name for this user.
        "emailAddress": "A String", # The email address of the user.
        "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
        "kind": "drive#user", # This is always drive#user.
        "permissionId": "A String", # The user's ID as visible in the permissions collection.
        "picture": { # The user's profile picture.
          "url": "A String", # A URL that points to a profile picture of this user.
        },
      },
      "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
      "createdDate": "A String", # The date when this reply was first created.
      "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
      "htmlContent": "A String", # HTML formatted content for this reply.
      "kind": "drive#commentReply", # This is always drive#commentReply.
      "modifiedDate": "A String", # The date when this reply was last modified.
      "replyId": "A String", # The ID of the reply.
      "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
          # - "resolve" - To resolve a comment.
          # - "reopen" - To reopen (un-resolve) a comment.
    },
  ],
  "kind": "drive#commentReplyList", # This is always drive#commentReplyList.
  "nextLink": "A String", # A link to the next page of replies.
  "nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
  "selfLink": "A String", # A link back to this list.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    

patch(fileId, commentId, replyId, body=None)

Updates an existing reply.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  replyId: string, The ID of the reply. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}


Returns:
  An object of the form:

    { # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}

update(fileId, commentId, replyId, body=None)

Updates an existing reply.

Args:
  fileId: string, The ID of the file. (required)
  commentId: string, The ID of the comment. (required)
  replyId: string, The ID of the reply. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}


Returns:
  An object of the form:

    { # A comment on a file in Google Drive.
  "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
    "displayName": "A String", # A plain text displayable name for this user.
    "emailAddress": "A String", # The email address of the user.
    "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
    "kind": "drive#user", # This is always drive#user.
    "permissionId": "A String", # The user's ID as visible in the permissions collection.
    "picture": { # The user's profile picture.
      "url": "A String", # A URL that points to a profile picture of this user.
    },
  },
  "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
  "createdDate": "A String", # The date when this reply was first created.
  "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
  "htmlContent": "A String", # HTML formatted content for this reply.
  "kind": "drive#commentReply", # This is always drive#commentReply.
  "modifiedDate": "A String", # The date when this reply was last modified.
  "replyId": "A String", # The ID of the reply.
  "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
      # - "resolve" - To resolve a comment.
      # - "reopen" - To reopen (un-resolve) a comment.
}