BlushyFace.Twitch
BlushyFace.Twitch.API.Helix.Endpoints.Moderation Class Reference

Implemented More...

Public Member Functions

 Moderation (HttpHandler httpHandler)
 
async Task< AutoModResponse > CheckAutoModStatusAsync (List< KeyValuePair< string, string >> parameters, AutoModRequest autoModData)
 
async Task< BannedUserResponse > GetBannedUsersAsync (List< KeyValuePair< string, string >> parameters)
 
async Task< BannedEventsResponse > GetBannedEventsAsync (List< KeyValuePair< string, string >> parameters)
 
async Task< ModeratorsResponse > GetModeratorsAsync (List< KeyValuePair< string, string >> parameters)
 
async Task< ModeratorEventsResponse > GetModeratorEventsAsync (List< KeyValuePair< string, string >> parameters)
 

Detailed Description

Implemented

Constructor & Destructor Documentation

◆ Moderation()

BlushyFace.Twitch.API.Helix.Endpoints.Moderation.Moderation ( HttpHandler  httpHandler)
inline

Parameters
settings

Member Function Documentation

◆ CheckAutoModStatusAsync()

async Task<AutoModResponse> BlushyFace.Twitch.API.Helix.Endpoints.Moderation.CheckAutoModStatusAsync ( List< KeyValuePair< string, string >>  parameters,
AutoModRequest  autoModData 
)
inline

Determines whether a string message meets the channel’s AutoMod requirements.

AutoMod is a moderation tool that blocks inappropriate or harassing chat with powerful moderator control. AutoMod detects misspellings and evasive language automatically. AutoMod uses machine learning and natural language processing algorithms to hold risky messages from chat so they can be reviewed by a channel moderator before appearing to other viewers in the chat. Moderators can approve or deny any message caught by AutoMod.

Requires OAuth Scope: moderation:read

More info: https://dev.twitch.tv/docs/api/reference#check-automod-status

Parameters
parameters
autoModData
Returns

◆ GetBannedEventsAsync()

async Task<BannedEventsResponse> BlushyFace.Twitch.API.Helix.Endpoints.Moderation.GetBannedEventsAsync ( List< KeyValuePair< string, string >>  parameters)
inline

Returns all user bans and un-bans in a channel.

Requires OAuth Scope: moderation:read

More info: https://dev.twitch.tv/docs/api/reference#get-banned-events

Parameters
parameters
Returns

◆ GetBannedUsersAsync()

async Task<BannedUserResponse> BlushyFace.Twitch.API.Helix.Endpoints.Moderation.GetBannedUsersAsync ( List< KeyValuePair< string, string >>  parameters)
inline

Returns all banned and timed-out users in a channel.

Requires OAuth Scope: moderation:read

More info: https://dev.twitch.tv/docs/api/reference#get-banned-users

Note: this endpoint is broken and the method will fetch 1 result per call or the results will be skewed. See https://github.com/twitchdev/issues/issues/18

Parameters
parameters
Returns

◆ GetModeratorEventsAsync()

async Task<ModeratorEventsResponse> BlushyFace.Twitch.API.Helix.Endpoints.Moderation.GetModeratorEventsAsync ( List< KeyValuePair< string, string >>  parameters)
inline

Returns a list of moderators or users added and removed as moderators from a channel.

Requires OAuth Scope: moderation:read

More info: Returns a list of moderators or users added and removed as moderators from a channel.

Parameters
parameters
Returns

◆ GetModeratorsAsync()

async Task<ModeratorsResponse> BlushyFace.Twitch.API.Helix.Endpoints.Moderation.GetModeratorsAsync ( List< KeyValuePair< string, string >>  parameters)
inline

Returns all moderators in a channel.

Requires OAuth Scope: moderation:read

More info: https://dev.twitch.tv/docs/api/reference#get-moderators

Parameters
parameters
Returns