blob: 7f60c55d3c7583a0f763a8af6ef6ce755402ca0f [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatBans.html">liveChatBans</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a chat ban.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <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 Parrott36e41bc2016-02-19 16:02:29 -080086<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
94 <pre>Deletes a chat ban.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080095
96Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -070097 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 Parrott36e41bc2016-02-19 16:02:29 -0800102</pre>
103</div>
104
105<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
107 <pre>Inserts a new resource into this collection.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800108
109Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 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'Mearadd494642020-05-01 07:42:23 -0700111 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800112 The object takes the form of:
113
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800115 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
116 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
117 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;youtube#liveChatBan&quot;`.
118 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
119 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
120 &quot;bannedUserDetails&quot;: {
121 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
122 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
123 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
124 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800125 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800126 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
127 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
128 },
129}
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800130
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800135
136Returns:
137 An object of the form:
138
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700139 { # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
141 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
142 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;youtube#liveChatBan&quot;`.
143 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
144 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
145 &quot;bannedUserDetails&quot;: {
146 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
147 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
148 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
149 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
150 },
151 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
152 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
153 },
154}</pre>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800155</div>
156
157</body></html>