blob: dfb048933ab23e992cecba844c408c91a0396fd1 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatBans.html">liveChatBans</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a chat ban.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id, x__xgafv=None)</code>
<pre>Deletes a chat ban.
Args:
id: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
<pre>Inserts a new resource into this collection.
Args:
part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; 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 &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
&quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string
# `&quot;youtube#liveChatBan&quot;`.
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
&quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
&quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
&quot;type&quot;: &quot;A String&quot;, # The type of ban.
&quot;bannedUserDetails&quot;: {
&quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
&quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
&quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
},
&quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
&quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string
# `&quot;youtube#liveChatBan&quot;`.
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
&quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
&quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
&quot;type&quot;: &quot;A String&quot;, # The type of ban.
&quot;bannedUserDetails&quot;: {
&quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
&quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
&quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
},
&quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
},
}</pre>
</div>
</body></html>