docs/dyn/youtube_v3.liveChatModerators.html - external/github.com/google/google-api-python-client - Git at Google

 <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.liveChatModerators.html">liveChatModerators</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 moderator.</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>
 <p class="toc_element">
   <code><a href="#list">list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Retrieves a list of resources, possibly filtered.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(id, x__xgafv=None)</code>
   <pre>Deletes a chat moderator.

 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 &lt;code&gt;&lt;strong&gt;liveChatModerator&lt;/strong&gt;&lt;/code&gt; resource represents a
     # moderator for a YouTube live chat. A chat moderator has the ability to
     # ban/unban users from a chat, remove message, etc.
   &quot;kind&quot;: &quot;youtube#liveChatModerator&quot;, # Identifies what kind of resource this is. Value: the fixed string
       # &lt;code&gt;&quot;youtube#liveChatModerator&quot;&lt;/code&gt;.
   &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the moderator.
   &quot;snippet&quot;: { # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
       # moderator.
     &quot;liveChatId&quot;: &quot;A String&quot;, # The ID of the live chat this moderator can act on.
     &quot;moderatorDetails&quot;: { # Details about the moderator.
       &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;etag&quot;: &quot;A String&quot;, # Etag of this resource.
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # A &lt;code&gt;&lt;strong&gt;liveChatModerator&lt;/strong&gt;&lt;/code&gt; resource represents a
       # moderator for a YouTube live chat. A chat moderator has the ability to
       # ban/unban users from a chat, remove message, etc.
     &quot;kind&quot;: &quot;youtube#liveChatModerator&quot;, # Identifies what kind of resource this is. Value: the fixed string
         # &lt;code&gt;&quot;youtube#liveChatModerator&quot;&lt;/code&gt;.
     &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the moderator.
     &quot;snippet&quot;: { # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
         # moderator.
       &quot;liveChatId&quot;: &quot;A String&quot;, # The ID of the live chat this moderator can act on.
       &quot;moderatorDetails&quot;: { # Details about the moderator.
         &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;etag&quot;: &quot;A String&quot;, # Etag of this resource.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)</code>
   <pre>Retrieves a list of resources, possibly filtered.

 Args:
   liveChatId: string, The id of the live chat for which moderators should be returned. (required)
   part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
 &lt;code&gt;liveChatModerator&lt;/code&gt; resource parts that the API response will
 include. Supported values are &lt;code&gt;id&lt;/code&gt; and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
   maxResults: integer, The &lt;code&gt;&lt;strong&gt;maxResults&lt;/strong&gt;&lt;/code&gt; parameter specifies the
 maximum number of items that should be returned in the result set.
   pageToken: string, The &lt;code&gt;&lt;strong&gt;pageToken&lt;/strong&gt;&lt;/code&gt; parameter identifies a specific
 page in the result set that should be returned. In an API response, the
 &lt;code&gt;nextPageToken&lt;/code&gt; and &lt;code&gt;prevPageToken&lt;/code&gt; properties
 identify other pages that could be retrieved.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     {
     &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
     &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
     &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
         # parameter to retrieve the next page in the result set.
     &quot;items&quot;: [ # A list of moderators that match the request criteria.
       { # A &lt;code&gt;&lt;strong&gt;liveChatModerator&lt;/strong&gt;&lt;/code&gt; resource represents a
           # moderator for a YouTube live chat. A chat moderator has the ability to
           # ban/unban users from a chat, remove message, etc.
         &quot;kind&quot;: &quot;youtube#liveChatModerator&quot;, # Identifies what kind of resource this is. Value: the fixed string
             # &lt;code&gt;&quot;youtube#liveChatModerator&quot;&lt;/code&gt;.
         &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the moderator.
         &quot;snippet&quot;: { # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
             # moderator.
           &quot;liveChatId&quot;: &quot;A String&quot;, # The ID of the live chat this moderator can act on.
           &quot;moderatorDetails&quot;: { # Details about the moderator.
             &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;etag&quot;: &quot;A String&quot;, # Etag of this resource.
       },
     ],
     &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items # General pagination information.
         # available and number of resources returned in a single page.
       &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
       &quot;totalResults&quot;: 42, # The total number of results in the result set.
     },
     &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
     &quot;prevPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
         # parameter to retrieve the previous page in the result set.
     &quot;kind&quot;: &quot;youtube#liveChatModeratorListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
         # &lt;code&gt;&quot;youtube#liveChatModeratorListResponse&quot;&lt;/code&gt;.
     &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
     },
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call &#x27;execute()&#x27; on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<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.liveChatModerators.html">liveChatModerators</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 moderator.</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>
	<p class="toc_element">
	<code><a href="#list">list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(id, x__xgafv=None)</code>
	<pre>Deletes a chat moderator.

	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 <code><strong>part</strong></code> 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 <code>snippet</code>. (required) (repeated)
	body: object, The request body.
	The object takes the form of:

	{ # A <code><strong>liveChatModerator</strong></code> resource represents a
	# moderator for a YouTube live chat. A chat moderator has the ability to
	# ban/unban users from a chat, remove message, etc.
	"kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string
	# <code>"youtube#liveChatModerator"</code>.
	"id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
	"snippet": { # The <code>snippet</code> object contains basic details about the
	# moderator.
	"liveChatId": "A String", # The ID of the live chat this moderator can act on.
	"moderatorDetails": { # Details about the moderator.
	"profileImageUrl": "A String", # The channels's avatar URL.
	"channelUrl": "A String", # The channel's URL.
	"displayName": "A String", # The channel's display name.
	"channelId": "A String", # The YouTube channel ID.
	},
	},
	"etag": "A String", # Etag of this resource.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # A <code><strong>liveChatModerator</strong></code> resource represents a
	# moderator for a YouTube live chat. A chat moderator has the ability to
	# ban/unban users from a chat, remove message, etc.
	"kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string
	# <code>"youtube#liveChatModerator"</code>.
	"id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
	"snippet": { # The <code>snippet</code> object contains basic details about the
	# moderator.
	"liveChatId": "A String", # The ID of the live chat this moderator can act on.
	"moderatorDetails": { # Details about the moderator.
	"profileImageUrl": "A String", # The channels's avatar URL.
	"channelUrl": "A String", # The channel's URL.
	"displayName": "A String", # The channel's display name.
	"channelId": "A String", # The YouTube channel ID.
	},
	},
	"etag": "A String", # Etag of this resource.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(liveChatId, part, maxResults=None, pageToken=None, x__xgafv=None)</code>
	<pre>Retrieves a list of resources, possibly filtered.

	Args:
	liveChatId: string, The id of the live chat for which moderators should be returned. (required)
	part: string, The <code><strong>part</strong></code> parameter specifies the
	<code>liveChatModerator</code> resource parts that the API response will
	include. Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated)
	maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
	maximum number of items that should be returned in the result set.
	pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
	page in the result set that should be returned. In an API response, the
	<code>nextPageToken</code> and <code>prevPageToken</code> properties
	identify other pages that could be retrieved.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{
	"etag": "A String", # Etag of this resource.
	"eventId": "A String", # Serialized EventId of the request which produced this response.
	"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
	# parameter to retrieve the next page in the result set.
	"items": [ # A list of moderators that match the request criteria.
	{ # A <code><strong>liveChatModerator</strong></code> resource represents a
	# moderator for a YouTube live chat. A chat moderator has the ability to
	# ban/unban users from a chat, remove message, etc.
	"kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string
	# <code>"youtube#liveChatModerator"</code>.
	"id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
	"snippet": { # The <code>snippet</code> object contains basic details about the
	# moderator.
	"liveChatId": "A String", # The ID of the live chat this moderator can act on.
	"moderatorDetails": { # Details about the moderator.
	"profileImageUrl": "A String", # The channels's avatar URL.
	"channelUrl": "A String", # The channel's URL.
	"displayName": "A String", # The channel's display name.
	"channelId": "A String", # The YouTube channel ID.
	},
	},
	"etag": "A String", # Etag of this resource.
	},
	],
	"pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.
	# available and number of resources returned in a single page.
	"resultsPerPage": 42, # The number of results included in the API response.
	"totalResults": 42, # The total number of results in the result set.
	},
	"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
	"prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
	# parameter to retrieve the previous page in the result set.
	"kind": "youtube#liveChatModeratorListResponse", # Identifies what kind of resource this is. Value: the fixed string
	# <code>"youtube#liveChatModeratorListResponse"</code>.
	"tokenPagination": { # Stub token pagination template to suppress results.
	},
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	</body></html>