Debian Codegraph @

docs/dyn/drive_v3.accessproposals.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="drive_v3.html">Google Drive API</a> . <a href="drive_v3.accessproposals.html">accessproposals</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(fileId, proposalId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).</p>
83 <p class="toc_element">
84 <code><a href="#list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#resolve">resolve(fileId, proposalId, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(fileId, proposalId, x__xgafv=None)</code>
100 <pre>Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).
101
102 Args:
103 fileId: string, Required. The ID of the item the request is on. (required)
104 proposalId: string, Required. The ID of the access proposal to resolve. (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110 Returns:
111 An object of the form:
112
113 { # Manage outstanding access proposals on a file.
114 &quot;createTime&quot;: &quot;A String&quot;, # The creation time.
115 &quot;fileId&quot;: &quot;A String&quot;, # The file ID that the proposal for access is on.
116 &quot;proposalId&quot;: &quot;A String&quot;, # The ID of the access proposal.
117 &quot;recipientEmailAddress&quot;: &quot;A String&quot;, # The email address of the user that will receive permissions, if accepted.
118 &quot;requestMessage&quot;: &quot;A String&quot;, # The message that the requester added to the proposal.
119 &quot;requesterEmailAddress&quot;: &quot;A String&quot;, # The email address of the requesting user.
120 &quot;rolesAndViews&quot;: [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
121 { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
122 &quot;role&quot;: &quot;A String&quot;, # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
123 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
124 },
125 ],
126 }</pre>
127 </div>
128
129 <div class="method">
130 <code class="details" id="list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</code>
131 <pre>List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn&#x27;t an approver, a 403 error is returned.
132
133 Args:
134 fileId: string, Required. The ID of the item the request is on. (required)
135 pageSize: integer, Optional. The number of results per page.
136 pageToken: string, Optional. The continuation token on the list of access requests.
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # The response to an access proposal list request.
146 &quot;accessProposals&quot;: [ # The list of access proposals. This field is only populated in Drive API v3.
147 { # Manage outstanding access proposals on a file.
148 &quot;createTime&quot;: &quot;A String&quot;, # The creation time.
149 &quot;fileId&quot;: &quot;A String&quot;, # The file ID that the proposal for access is on.
150 &quot;proposalId&quot;: &quot;A String&quot;, # The ID of the access proposal.
151 &quot;recipientEmailAddress&quot;: &quot;A String&quot;, # The email address of the user that will receive permissions, if accepted.
152 &quot;requestMessage&quot;: &quot;A String&quot;, # The message that the requester added to the proposal.
153 &quot;requesterEmailAddress&quot;: &quot;A String&quot;, # The email address of the requesting user.
154 &quot;rolesAndViews&quot;: [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
155 { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
156 &quot;role&quot;: &quot;A String&quot;, # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
157 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
158 },
159 ],
160 },
161 ],
162 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
163 }</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="list_next">list_next()</code>
168 <pre>Retrieves the next page of results.
169
170 Args:
171 previous_request: The request for the previous page. (required)
172 previous_response: The response from the request for the previous page. (required)
173
174 Returns:
175 A request object that you can call &#x27;execute()&#x27; on to request the next
176 page. Returns None if there are no more items in the collection.
177 </pre>
178 </div>
179
180 <div class="method">
181 <code class="details" id="resolve">resolve(fileId, proposalId, body=None, x__xgafv=None)</code>
182 <pre>Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).
183
184 Args:
185 fileId: string, Required. The ID of the item the request is on. (required)
186 proposalId: string, Required. The ID of the access proposal to resolve. (required)
187 body: object, The request body.
188 The object takes the form of:
189
190 { # Request message for resolving an AccessProposal on a file.
191 &quot;action&quot;: &quot;A String&quot;, # Required. The action to take on the access proposal.
192 &quot;role&quot;: [ # Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.
193 &quot;A String&quot;,
194 ],
195 &quot;sendNotification&quot;: True or False, # Optional. Whether to send an email to the requester when the access proposal is denied or accepted.
196 &quot;view&quot;: &quot;A String&quot;, # Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.
197 }
198
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203 </pre>
204 </div>
205
206 </body></html>