• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<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
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.liveChatBans.html">liveChatBans</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(id)</a></code></p>
79<p class="firstline">Removes a chat ban.</p>
80<p class="toc_element">
81  <code><a href="#insert">insert(part, body)</a></code></p>
82<p class="firstline">Adds a new ban to the chat.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="delete">delete(id)</code>
86  <pre>Removes a chat ban.
87
88Args:
89  id: string, The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat. (required)
90</pre>
91</div>
92
93<div class="method">
94    <code class="details" id="insert">insert(part, body)</code>
95  <pre>Adds a new ban to the chat.
96
97Args:
98  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)
99  body: object, The request body. (required)
100    The object takes the form of:
101
102{ # A liveChatBan resource represents a ban for a YouTube live chat.
103    "snippet": { # The snippet object contains basic details about the ban.
104      "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
105      "liveChatId": "A String", # The chat this ban is pertinent to.
106      "bannedUserDetails": {
107        "channelId": "A String", # The YouTube channel ID.
108        "displayName": "A String", # The channel's display name.
109        "profileImageUrl": "A String", # The channels's avatar URL.
110        "channelUrl": "A String", # The channel's URL.
111      },
112      "type": "A String", # The type of ban.
113    },
114    "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
115    "etag": "A String", # Etag of this resource.
116    "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
117  }
118
119
120Returns:
121  An object of the form:
122
123    { # A liveChatBan resource represents a ban for a YouTube live chat.
124      "snippet": { # The snippet object contains basic details about the ban.
125        "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
126        "liveChatId": "A String", # The chat this ban is pertinent to.
127        "bannedUserDetails": {
128          "channelId": "A String", # The YouTube channel ID.
129          "displayName": "A String", # The channel's display name.
130          "profileImageUrl": "A String", # The channels's avatar URL.
131          "channelUrl": "A String", # The channel's URL.
132        },
133        "type": "A String", # The type of ban.
134      },
135      "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
136      "etag": "A String", # Etag of this resource.
137      "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
138    }</pre>
139</div>
140
141</body></html>