blob: dfb048933ab23e992cecba844c408c91a0396fd1 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070078 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a chat ban.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080080<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Inserts a new resource into this collection.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083<h3>Method Details</h3>
84<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070085 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
86 <pre>Deletes a chat ban.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080087
88Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -070089 id: string, A parameter (required)
90 x__xgafv: string, V1 error format.
91 Allowed values
92 1 - v1 error format
93 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080094</pre>
95</div>
96
97<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070098 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
99 <pre>Inserts a new resource into this collection.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100
101Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700102 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter serves two purposes in
103this operation. It identifies the properties that the write operation will
104set as well as the properties that the API response returns. Set the
105parameter value to &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800107 The object takes the form of:
108
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
110 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string
111 # `&quot;youtube#liveChatBan&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
113 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
Bu Sun Kim65020912020-05-20 12:08:20 -0700115 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
116 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700117 &quot;bannedUserDetails&quot;: {
118 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
119 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
120 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
121 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
122 },
123 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800124 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800125 }
126
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800131
132Returns:
133 An object of the form:
134
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700135 { # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
136 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string
137 # `&quot;youtube#liveChatBan&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
139 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700140 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
142 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;bannedUserDetails&quot;: {
144 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
145 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
146 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
147 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
148 },
149 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800150 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800151 }</pre>
152</div>
153
154</body></html>