Blame - docs/dyn/calendar_v3.acl.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

108

ruleId: string, ACL rule identifier. (required)

</pre>

</div>

<code class="details" id="get">get(calendarId, ruleId)</code>

114

<pre>Returns an access control rule.

115

116

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

118

ruleId: string, ACL rule identifier. (required)

119

120

Returns:

121

An object of the form:

122

123

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"etag": "A String", # ETag of the resource.

125

"id": "A String", # Identifier of the ACL rule.

126

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

127

"role": "A String", # The role assigned to the scope. Possible values are:

128

# - "none" - Provides no access.

129

# - "freeBusyReader" - Provides read access to free/busy information.

130

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

131

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

132

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

133

"scope": { # The scope of the rule.

134

"type": "A String", # The type of the scope. Possible values are:

135

# - "default" - The public scope. This is the default value.

136

# - "user" - Limits the scope to a single user.

137

# - "group" - Limits the scope to a group.

138

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

139

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

140

},

141

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

145

<code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

146

<pre>Creates an access control rule.

147

148

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

149

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

150

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

151

The object takes the form of:

152

153

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

154

"etag": "A String", # ETag of the resource.

155

"id": "A String", # Identifier of the ACL rule.

156

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

157

"role": "A String", # The role assigned to the scope. Possible values are:

158

# - "none" - Provides no access.

159

# - "freeBusyReader" - Provides read access to free/busy information.

160

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

161

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

162

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

163

"scope": { # The scope of the rule.

164

"type": "A String", # The type of the scope. Possible values are:

165

# - "default" - The public scope. This is the default value.

166

# - "user" - Limits the scope to a single user.

167

# - "group" - Limits the scope to a group.

168

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

169

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

170

},

171

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

172

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

173

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

174

175

Returns:

176

An object of the form:

177

178

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

"etag": "A String", # ETag of the resource.

180

"id": "A String", # Identifier of the ACL rule.

181

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

182

"role": "A String", # The role assigned to the scope. Possible values are:

183

# - "none" - Provides no access.

184

# - "freeBusyReader" - Provides read access to free/busy information.

185

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

186

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

187

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

188

"scope": { # The scope of the rule.

189

"type": "A String", # The type of the scope. Possible values are:

190

# - "default" - The public scope. This is the default value.

191

# - "user" - Limits the scope to a single user.

192

# - "group" - Limits the scope to a group.

193

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

194

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

195

},

196

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

<code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

201

<pre>Returns the rules in the access control list for the calendar.

202

203

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

204

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

205

maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

206

pageToken: string, Token specifying which result page to return. Optional.

207

showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

208

syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.

209

If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.

210

Learn more about incremental synchronization.

211

Optional. The default is to return all entries.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

212

213

Returns:

214

An object of the form:

215

216

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

217

"etag": "A String", # ETag of the collection.

218

"items": [ # List of rules on the access control list.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

219

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

220

"etag": "A String", # ETag of the resource.

221

"id": "A String", # Identifier of the ACL rule.

222

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

223

"role": "A String", # The role assigned to the scope. Possible values are:

224

# - "none" - Provides no access.

225

# - "freeBusyReader" - Provides read access to free/busy information.

226

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

227

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

228

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

229

"scope": { # The scope of the rule.

230

"type": "A String", # The type of the scope. Possible values are:

231

# - "default" - The public scope. This is the default value.

232

# - "user" - Limits the scope to a single user.

233

# - "group" - Limits the scope to a group.

234

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

235

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

236

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

238

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

239

"kind": "calendar#acl", # Type of the collection ("calendar#acl").

240

"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

241

"nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

247

<pre>Retrieves the next page of results.

248

249

Args:

250

previous_request: The request for the previous page. (required)

251

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

252

253

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

254

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

255

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

260

<code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

261

<pre>Updates an access control rule. This method supports patch semantics.

262

263

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

265

ruleId: string, ACL rule identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

266

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

267

The object takes the form of:

268

269

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

270

"etag": "A String", # ETag of the resource.

271

"id": "A String", # Identifier of the ACL rule.

272

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

273

"role": "A String", # The role assigned to the scope. Possible values are:

274

# - "none" - Provides no access.

275

# - "freeBusyReader" - Provides read access to free/busy information.

276

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

277

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

278

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

279

"scope": { # The scope of the rule.

280

"type": "A String", # The type of the scope. Possible values are:

281

# - "default" - The public scope. This is the default value.

282

# - "user" - Limits the scope to a single user.

283

# - "group" - Limits the scope to a group.

284

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

285

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

286

},

287

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

288

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

289

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

290

291

Returns:

292

An object of the form:

293

294

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

295

"etag": "A String", # ETag of the resource.

296

"id": "A String", # Identifier of the ACL rule.

297

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

298

"role": "A String", # The role assigned to the scope. Possible values are:

299

# - "none" - Provides no access.

300

# - "freeBusyReader" - Provides read access to free/busy information.

301

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

302

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

303

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

304

"scope": { # The scope of the rule.

305

"type": "A String", # The type of the scope. Possible values are:

306

# - "default" - The public scope. This is the default value.

307

# - "user" - Limits the scope to a single user.

308

# - "group" - Limits the scope to a group.

309

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

310

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

311

},

312

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

316

<code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

317

<pre>Updates an access control rule.

318

319

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

320

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

321

ruleId: string, ACL rule identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

322

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

323

The object takes the form of:

324

325

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

326

"etag": "A String", # ETag of the resource.

327

"id": "A String", # Identifier of the ACL rule.

328

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

329

"role": "A String", # The role assigned to the scope. Possible values are:

330

# - "none" - Provides no access.

331

# - "freeBusyReader" - Provides read access to free/busy information.

332

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

333

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

334

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

335

"scope": { # The scope of the rule.

336

"type": "A String", # The type of the scope. Possible values are:

337

# - "default" - The public scope. This is the default value.

338

# - "user" - Limits the scope to a single user.

339

# - "group" - Limits the scope to a group.

340

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

341

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

342

},

343

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

344

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

345

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

346

347

Returns:

348

An object of the form:

349

350

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

351

"etag": "A String", # ETag of the resource.

352

"id": "A String", # Identifier of the ACL rule.

353

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

354

"role": "A String", # The role assigned to the scope. Possible values are:

355

# - "none" - Provides no access.

356

# - "freeBusyReader" - Provides read access to free/busy information.

357

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

358

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

359

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

360

"scope": { # The scope of the rule.

361

"type": "A String", # The type of the scope. Possible values are:

362

# - "default" - The public scope. This is the default value.

363

# - "user" - Limits the scope to a single user.

364

# - "group" - Limits the scope to a group.

365

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

366

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

367

},

368

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

372

<code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

373

<pre>Watch for changes to ACL resources.

374

375

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

376

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

377

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

378

The object takes the form of:

379

380

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

381

"address": "A String", # The address where notifications are delivered for this channel.

382

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

383

"id": "A String", # A UUID or similar unique string that identifies this channel.

384

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

385

"params": { # Additional parameters controlling delivery channel behavior. Optional.

386

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

387

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

389

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

390

"resourceUri": "A String", # A version-specific identifier for the watched resource.

391

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

392

"type": "A String", # The type of delivery mechanism used for this channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

393

}

394

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

395

maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

396

pageToken: string, Token specifying which result page to return. Optional.

397

showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

398

syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.

399

If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.

400

Learn more about incremental synchronization.

401

Optional. The default is to return all entries.

John Asmuth