Class: Onlyfans::Models::Posts::CommentListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onlyfans/models/posts/comment_list_params.rb

Overview

Defined Under Namespace

Modules: Sort

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(account:, post_id:, limit: nil, offset: nil, sort: nil, request_options: {}) ⇒ Object

Parameters:

  • account (String)
  • post_id (String)
  • limit (Integer) (defaults to: nil)

    Number of comments to return (default = 10)

  • offset (Integer) (defaults to: nil)

    Number of comments to skip for pagination

  • sort (Symbol, Onlyfans::Models::Posts::CommentListParams::Sort) (defaults to: nil)

    Sort the returned comments (default = desc)

  • request_options (Onlyfans::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 39

Instance Attribute Details

#accountString

Returns:

  • (String)


14
# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 14

required :account, String

#limitInteger?

Number of comments to return (default = 10)

Returns:

  • (Integer, nil)


25
# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 25

optional :limit, Integer

#offsetInteger?

Number of comments to skip for pagination

Returns:

  • (Integer, nil)


31
# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 31

optional :offset, Integer

#post_idString

Returns:

  • (String)


19
# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 19

required :post_id, String

#sortSymbol, ...

Sort the returned comments (default = desc)



37
# File 'lib/onlyfans/models/posts/comment_list_params.rb', line 37

optional :sort, enum: -> { Onlyfans::Posts::CommentListParams::Sort }