Class: ModerationAPI::Models::ContentSubmitParams::Content::Image

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moderation_api/models/content_submit_params.rb,
sig/moderation_api/models/content_submit_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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 ⇒ Image

Returns a new instance of Image.

Parameters:

  • data: (String)
  • url: (String)
  • type: (:image) 


136
 
# File 'sig/moderation_api/models/content_submit_params.rbs', line 136

def initialize: (?data: String, ?url: String, ?type: :image) -> void

Instance Attribute Details

#data ⇒ String?

Base64-encoded image data. Either url or data must be provided. Note: base64 images are not stored and will not appear in the review queue.

Parameters:

  • (String)

Returns:

  • (String, nil) 


163
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 163

optional :data, String

#type ⇒ Symbol, :image

Parameters:

  • value (:image)

Returns:

  • (Symbol, :image) 


156
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 156

required :type, const: :image

#url ⇒ String?

A public URL of the image content. Either url or data must be provided.

Parameters:

  • (String)

Returns:

  • (String, nil) 


169
 
# File 'lib/moderation_api/models/content_submit_params.rb', line 169

optional :url, String

Instance Method Details

#to_hash ⇒ { type: :image, data: String, url: String }

Returns:

  • ({ type: :image, data: String, url: String }) 


138
 
# File 'sig/moderation_api/models/content_submit_params.rbs', line 138

def to_hash: -> { type: :image, data: String, url: String }