Google Drive API . accessproposals

close()

Close httplib2 connections.

get(fileId, proposalId, x__xgafv=None)

Retrieves an AccessProposal by ID.

Args:
  fileId: string, Required. The id of the item the request is on. (required)
  proposalId: string, Required. The id of the access proposal to resolve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Access Proposal resource for outstanding access proposals on a file
  "createTime": "A String", # The creation time
  "fileId": "A String", # The file id that the proposal for access is on
  "proposalId": "A String", # The id of the access proposal
  "recipientEmailAddress": "A String", # The email address of the user that will receive permissions if accepted
  "requestMessage": "A String", # The message that the requester added to the proposal
  "requesterEmailAddress": "A String", # The email address of the requesting user
  "rolesAndViews": [ # A wrapper for the role and view of an access proposal.
    { # A wrapper for the role and view of an access proposal.
      "role": "A String", # The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`
      "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.
    },
  ],
}

list(fileId, pageSize=None, pageToken=None, x__xgafv=None)

List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.

Args:
  fileId: string, Required. The id of the item the request is on. (required)
  pageSize: integer, Optional. The number of results per page
  pageToken: string, Optional. The continuation token on the list of access requests.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response to an Access Proposal list request.
  "accessProposals": [ # The list of Access Proposals. This field is only populated in v3 and v3beta.
    { # The Access Proposal resource for outstanding access proposals on a file
      "createTime": "A String", # The creation time
      "fileId": "A String", # The file id that the proposal for access is on
      "proposalId": "A String", # The id of the access proposal
      "recipientEmailAddress": "A String", # The email address of the user that will receive permissions if accepted
      "requestMessage": "A String", # The message that the requester added to the proposal
      "requesterEmailAddress": "A String", # The email address of the requesting user
      "rolesAndViews": [ # A wrapper for the role and view of an access proposal.
        { # A wrapper for the role and view of an access proposal.
          "role": "A String", # The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`
          "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # The continuation token for the next page of results. This will be absent if the end of the results 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.
}

list_next()

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.
        

resolve(fileId, proposalId, body=None, x__xgafv=None)

Used to approve or deny an Access Proposal.

Args:
  fileId: string, Required. The id of the item the request is on. (required)
  proposalId: string, Required. The id of the access proposal to resolve. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for resolving an AccessProposal on a file.
  "action": "A String", # Required. The action to take on the AccessProposal.
  "role": [ # Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action.
    "A String",
  ],
  "sendNotification": True or False, # Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted.
  "view": "A String", # Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format