Blame - docs/dyn/youtube_v3.liveChatBans.html - platform/external/python/google-api-python-client

blob: c1f623adafab1e4cf493ff7467930edffe08f6f9 [file] [log] [blame]

Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[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
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	75	<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatBans.html">liveChatBans</a></h1>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes a chat ban.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	84	<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Inserts a new resource into this collection.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	86	<h3>Method Details</h3>
				87	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<code class="details" id="close">close()</code>
				89	<pre>Close httplib2 connections.</pre>
				90	</div>
				91
				92	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<code class="details" id="delete">delete(id, x__xgafv=None)</code>
				94	<pre>Deletes a chat ban.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	95
				96	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	97	id: string, A parameter (required)
				98	x__xgafv: string, V1 error format.
				99	Allowed values
				100	1 - v1 error format
				101	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	102	</pre>
				103	</div>
				104
				105	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	106	<code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
				107	<pre>Inserts a new resource into this collection.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	108
				109	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. (required) (repeated)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	body: object, The request body.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	112	The object takes the form of:
				113
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	115	"id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	116	"snippet": { # The `snippet` object contains basic details about the ban.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	117	"banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	118	"bannedUserDetails": {
				119	"profileImageUrl": "A String", # The channels's avatar URL.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	120	"channelId": "A String", # The YouTube channel ID.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	121	"channelUrl": "A String", # The channel's URL.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	122	"displayName": "A String", # The channel's display name.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	123	},
				124	"type": "A String", # The type of ban.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	125	"liveChatId": "A String", # The chat this ban is pertinent to.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	126	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	127	"etag": "A String", # Etag of this resource.
				128	"kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string `"youtube#liveChatBan"`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	129	}
				130
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	131	x__xgafv: string, V1 error format.
				132	Allowed values
				133	1 - v1 error format
				134	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	135
				136	Returns:
				137	An object of the form:
				138
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	139	{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	140	"id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	141	"snippet": { # The `snippet` object contains basic details about the ban.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	142	"banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	143	"bannedUserDetails": {
				144	"profileImageUrl": "A String", # The channels's avatar URL.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	145	"channelId": "A String", # The YouTube channel ID.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	146	"channelUrl": "A String", # The channel's URL.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	147	"displayName": "A String", # The channel's display name.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	148	},
				149	"type": "A String", # The type of ban.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	150	"liveChatId": "A String", # The chat this ban is pertinent to.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	151	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	152	"etag": "A String", # Etag of this resource.
				153	"kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string `"youtube#liveChatBan"`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	154	}</pre>
				155	</div>
				156
				157	</body></html>