LiveChatBansApi
extends AbstractApi
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
Banning people from a live chat, and lifting bans.
Reach it as $youtube->liveChatBans. Every method takes the parameters Google
documents, by the same names: use named arguments for the optional ones.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- delete() : PromiseInterface<string|int, null>
- Deletes a chat ban.
- insert() : PromiseInterface<string|int, LiveChatBan>
- Inserts a new resource into this collection.
- call() : PromiseInterface<string|int, mixed>
- streamed() : PromiseInterface<string|int, ResponseStream>
- Opens a server-streamed call and reads its body as it arrives.
Properties
$youtube read-only
protected
YouTube
$youtube
Methods
__construct()
public
__construct(YouTube $youtube) : mixed
Parameters
- $youtube : YouTube
delete()
Deletes a chat ban.
public
delete(string $id) : PromiseInterface<string|int, null>
Costs 50 units of quota.
Parameters
- $id : string
Tags
Return values
PromiseInterface<string|int, null>insert()
Inserts a new resource into this collection.
public
insert(array<int, string>|string $part, LiveChatBan|array<string, mixed> $body) : PromiseInterface<string|int, LiveChatBan>
Costs 50 units of quota.
Parameters
- $part : array<int, string>|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.
- $body : LiveChatBan|array<string, mixed>
-
The LiveChatBan to send.
Tags
Return values
PromiseInterface<string|int, LiveChatBan>call()
protected
call(string $endpoint, string $method, string $path[, array<string, mixed> $query = [] ][, array<string, mixed>|JsonSerializable|null $body = null ][, string|null $returns = null ][, ?Media $media = null ][, ?string $uploadPath = null ][, bool $download = false ]) : PromiseInterface<string|int, mixed>
Parameters
- $endpoint : string
-
The API method, e.g.
liveChatMessages.list. - $method : string
- $path : string
- $query : array<string, mixed> = []
- $body : array<string, mixed>|JsonSerializable|null = null
- $returns : string|null = null
-
The type token the result hydrates as; null leaves it raw.
- $media : ?Media = null
- $uploadPath : ?string = null
- $download : bool = false
Return values
PromiseInterface<string|int, mixed>streamed()
Opens a server-streamed call and reads its body as it arrives.
protected
streamed(string $endpoint, string $path, array<string, mixed> $query, string $returns) : PromiseInterface<string|int, ResponseStream>
Parameters
- $endpoint : string
- $path : string
- $query : array<string, mixed>
- $returns : string
-
The type token each element hydrates as.