1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v3.html">Google Drive API</a> . <a href="drive_v3.accessproposals.html">accessproposals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, proposalId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an AccessProposal by ID.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#resolve">resolve(fileId, proposalId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Used to approve or deny an Access Proposal.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, proposalId, x__xgafv=None)</code>
<pre>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.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="resolve">resolve(fileId, proposalId, body=None, x__xgafv=None)</code>
<pre>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
</pre>
</div>
</body></html>
|
