TwitchApi.Users.BlockUser (TwitchApi v0.1.2) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
This example blocks a user with an ID of 198704263 on behalf of the authenticated user.
requests:
curl -X PUT 'https://api.twitch.tv/helix/users/blocks?target_user_id=198704263'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz'
Example response from twitch api docs:
descriptions:
responses:
204NoContent
Link to this section Summary
Types
Reason for blocking the user. Valid values: "spam", "harassment", or "other".
Source context for blocking the user. Valid values: "chat", "whisper".
User ID of the user to be blocked.
Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"
Functions
Description:
Blocks the specified user on behalf of the authenticated user.
Link to this section Types
Specs
reason() :: %{reason: String.t()}
Reason for blocking the user. Valid values: "spam", "harassment", or "other".
Specs
source_context() :: %{source_context: String.t()}
Source context for blocking the user. Valid values: "chat", "whisper".
Specs
target_user_id() :: %{target_user_id: String.t()}
User ID of the user to be blocked.
Specs
Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"
Link to this section Functions
Specs
call(target_user_id() | source_context() | reason(), user_info()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
Blocks the specified user on behalf of the authenticated user.
Required authentication:
OAuth user token required Required scope: user:manage:blocked_users