Blame - docs/dyn/keep_v1.notes.permissions.html - platform/external/python/google-api-python-client

blob: f16154dece5eee691604fc3a7be559293b11aa99 [file] [log] [blame]

yoshi-code-bot	cb945f3	2021-06-08 00:36:03 -0700	[diff] [blame]	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="keep_v1.html">Google Keep API</a> . <a href="keep_v1.notes.html">notes</a> . <a href="keep_v1.notes.permissions.html">permissions</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	79	<p class="firstline">Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.</p>
yoshi-code-bot	cb945f3	2021-06-08 00:36:03 -0700	[diff] [blame]	80	<p class="toc_element">
				81	<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.</p>
				83	<p class="toc_element">
				84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<h3>Method Details</h3>
				87	<div class="method">
				88	<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	89	<pre>Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.
yoshi-code-bot	cb945f3	2021-06-08 00:36:03 -0700	[diff] [blame]	90
				91	Args:
				92	parent: string, The parent resource shared by all Permissions being created. Format: `notes/{note}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field. (required)
				93	body: object, The request body.
				94	The object takes the form of:
				95
				96	{ # The request to add one or more permissions on the note. Currently, only the `WRITER` role may be specified. If adding a permission fails, then the entire request fails and no changes are made.
				97	"requests": [ # The request message specifying the resources to create.
				98	{ # The request to add a single permission on the note.
				99	"parent": "A String", # Required. The parent note where this permission will be created. Format: `notes/{note}`
				100	"permission": { # A single permission on the note. Associates a `member` with a `role`. # Required. The permission to create. One of Permission.email, User.email or Group.email must be supplied.
				101	"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	102	"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
yoshi-code-bot	cb945f3	2021-06-08 00:36:03 -0700	[diff] [blame]	103	"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
				104	},
				105	"group": { # Describes a single Group. # Output only. The group to which this role applies.
				106	"email": "A String", # The group email.
				107	},
				108	"name": "A String", # Output only. The resource name.
				109	"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
				110	"user": { # Describes a single user. # Output only. The user to whom this role applies.
				111	"email": "A String", # The user's email.
				112	},
				113	},
				114	},
				115	],
				116	}
				117
				118	x__xgafv: string, V1 error format.
				119	Allowed values
				120	1 - v1 error format
				121	2 - v2 error format
				122
				123	Returns:
				124	An object of the form:
				125
				126	{ # The response for creating permissions on a note.
				127	"permissions": [ # Permissions created.
				128	{ # A single permission on the note. Associates a `member` with a `role`.
				129	"deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame^]	130	"email": "A String", # The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
yoshi-code-bot	cb945f3	2021-06-08 00:36:03 -0700	[diff] [blame]	131	"family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
				132	},
				133	"group": { # Describes a single Group. # Output only. The group to which this role applies.
				134	"email": "A String", # The group email.
				135	},
				136	"name": "A String", # Output only. The resource name.
				137	"role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
				138	"user": { # Describes a single user. # Output only. The user to whom this role applies.
				139	"email": "A String", # The user's email.
				140	},
				141	},
				142	],
				143	}</pre>
				144	</div>
				145
				146	<div class="method">
				147	<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
				148	<pre>Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
				149
				150	Args:
				151	parent: string, The parent resource shared by all permissions being deleted. Format: `notes/{note}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field. (required)
				152	body: object, The request body.
				153	The object takes the form of:
				154
				155	{ # The request to remove one or more permissions from a note. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
				156	"names": [ # Required. The names of the permissions to delete. Format: `notes/{note}/permissions/{permission}`
				157	"A String",
				158	],
				159	}
				160
				161	x__xgafv: string, V1 error format.
				162	Allowed values
				163	1 - v1 error format
				164	2 - v2 error format
				165
				166	Returns:
				167	An object of the form:
				168
				169	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				170	}</pre>
				171	</div>
				172
				173	<div class="method">
				174	<code class="details" id="close">close()</code>
				175	<pre>Close httplib2 connections.</pre>
				176	</div>
				177
				178	</body></html>