Class: Spotted::Models::Me::PlaylistListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Spotted::Models::Me::PlaylistListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/spotted/models/me/playlist_list_params.rb

Overview

See Also:

• Resources::Me::Playlists#list

Instance Attribute Summary

• #limit ⇒ Integer^?

  The maximum number of items to return.

• #offset ⇒ Integer^?

  ‘The index of the first playlist to return.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, offset: nil, request_options: {}) ⇒ Object constructor

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

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

Some parameter documentations has been truncated, see Spotted::Models::Me::PlaylistListParams for more details.

Parameters:

• limit (Integer) (defaults to: nil) —

  The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

• offset (Integer) (defaults to: nil) —

  ‘The index of the first playlist to return. Default:

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

# File 'lib/spotted/models/me/playlist_list_params.rb', line 24

Instance Attribute Details

#limit ⇒ Integer^?

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Returns:

• (Integer, nil)

# File 'lib/spotted/models/me/playlist_list_params.rb', line 15

optional :limit, Integer

#offset ⇒ Integer^?

‘The index of the first playlist to return. Default: 0 (the first object). Maximum offset: 100.000. Use with `limit` to get the next set of playlists.’

Returns:

• (Integer, nil)

# File 'lib/spotted/models/me/playlist_list_params.rb', line 22

optional :offset, Integer