Class: Twitch::AutomodResource

Inherits:
Resource
  • Object
show all
Defined in:
lib/twitch/resources/automod.rb

Instance Attribute Summary

Attributes inherited from Resource

#client

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from Twitch::Resource

Instance Method Details

#check_status(broadcaster_id:, id:, text:) ⇒ Object

Checks if a supplied message meets the channel’s AutoMod requirements Required scope: moderation:read



5
6
7
8
9
 
# File 'lib/twitch/resources/automod.rb', line 5

def check_status(broadcaster_id:, id:, text:)
  attrs = { broadcaster_id: broadcaster_id, data: [ { msg_id: id, msg_text: text } ] }
  response = post_request("moderation/enforcements/status", body: attrs)
  AutomodStatus.new response.body.dig("data")[0]
end

#check_status_multiple(broadcaster_id:, messages:) ⇒ Object

Checks if multiple supplied messages meet the channel’s AutoMod requirements Required scope: moderation:read



13
14
15
16
17
 
# File 'lib/twitch/resources/automod.rb', line 13

def check_status_multiple(broadcaster_id:, messages:)
  attrs = { broadcaster_id: broadcaster_id, data: messages }
  response = post_request("moderation/enforcements/status", body: attrs)
  Collection.from_response(response, type: AutomodStatus)
end

#manage_message(user_id:, msg_id:, action:) ⇒ Object 



19
20
21
22
 
# File 'lib/twitch/resources/automod.rb', line 19

def manage_message(user_id:, msg_id:, action:)
  attrs = { user_id: user_id, msg_id: msg_id, action: action }
  post_request("moderation/automod/message", body: attrs)
end

#settings(broadcaster_id:, moderator_id:) ⇒ Object 



24
25
26
27
 
# File 'lib/twitch/resources/automod.rb', line 24

def settings(broadcaster_id:, moderator_id:)
  response = get_request("moderation/automod/settings?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}")
  AutomodSetting.new response.body.dig("data")[0]
end

#update_settings(broadcaster_id:, moderator_id:, **params) ⇒ Object 



29
30
31
32
33
 
# File 'lib/twitch/resources/automod.rb', line 29

def update_settings(broadcaster_id:, moderator_id:, **params)
  attrs = { broadcaster_id: broadcaster_id, moderator_id: moderator_id }
  response = put_request("moderation/automod/settings", body: attrs.merge(params))
  AutomodSetting.new response.body.dig("data")[0]
end