Class: Spotted::Models::Me::PlayerSetVolumeParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/spotted/models/me/player_set_volume_params.rb

Overview

See Also:

• Resources::Me::Player#set_volume

Instance Attribute Summary

• #device_id ⇒ String^?

  The id of the device this command is targeting.

• #volume_percent ⇒ Integer

  The volume to set.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(volume_percent: , device_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see PlayerSetVolumeParams 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(volume_percent: , device_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• volume_percent (Integer) (defaults to: ) —

  The volume to set. Must be a value from 0 to 100 inclusive.

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

  The id of the device this command is targeting. If not supplied, the user’s curr

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

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

Instance Attribute Details

#device_id ⇒ String^?

The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.

Returns:

• (String, nil)

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

optional :device_id, String

#volume_percent ⇒ Integer

The volume to set. Must be a value from 0 to 100 inclusive.

Returns:

• (Integer)

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

required :volume_percent, Integer