Class: ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction

Defined in:

lib/moderation_api/models/webhook_event.rb

Overview

See Also:

• #client_action

Defined Under Namespace

Modules: Action, Behavior

Instance Attribute Summary

• #action ⇒ Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Action

  Your recommendation for the content: allow, review, or reject.

• #behavior ⇒ Symbol, ...

  How your recommendation combines with ours.

• #reason ⇒ String^?

  A human-readable explanation for your recommendation.

• #source ⇒ String^?

  Where your recommendation came from, e.g.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(action:, behavior: nil, reason: nil, source: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ClientAction for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(action:, behavior: nil, reason: nil, source: nil) ⇒ Object

Some parameter documentations has been truncated, see ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction for more details.

A recommendation from your own client-side flagging.

Parameters:

• action (Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Action) —

  Your recommendation for the content: allow, review, or reject.

• behavior (Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Behavior) (defaults to: nil) —

  How your recommendation combines with ours. Defaults to ‘escalate’, which only a

• reason (String) (defaults to: nil) —

  A human-readable explanation for your recommendation.

• source (String) (defaults to: nil) —

  Where your recommendation came from, e.g. “banned-ip”.

# File 'lib/moderation_api/models/webhook_event.rb', line 3933

Instance Attribute Details

#action ⇒ Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Action

Your recommendation for the content: allow, review, or reject.

Returns:

• (Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Action)

# File 'lib/moderation_api/models/webhook_event.rb', line 3910

required :action,
enum: -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Action }

#behavior ⇒ Symbol, ...

How your recommendation combines with ours. Defaults to ‘escalate’, which only applies it when stricter than ours; ‘override’ replaces ours outright.

Returns:

• (Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Behavior, nil)

# File 'lib/moderation_api/models/webhook_event.rb', line 3918

optional :behavior,
enum: -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction::Behavior }

#reason ⇒ String^?

A human-readable explanation for your recommendation.

Returns:

• (String, nil)

# File 'lib/moderation_api/models/webhook_event.rb', line 3925

optional :reason, String

#source ⇒ String^?

Where your recommendation came from, e.g. “banned-ip”.

Returns:

• (String, nil)

# File 'lib/moderation_api/models/webhook_event.rb', line 3931

optional :source, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/moderation_api/models/webhook_event.rb', line 3958