Class: Vk::API::Places::Methods::GetCheckins
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Places::Methods::GetCheckins
- Defined in:
- lib/vk/api/places/methods/get_checkins.rb
Overview
Returns a list of user check-ins at locations according to the set parameters.
Arguments collapse
-
#count ⇒ Integer
Number of check-ins to return.
-
#friends_only ⇒ Boolean
'1' — to return only check-ins with set geographical coordinates.
-
#latitude ⇒ Number
Geographical latitude of the initial search point, in degrees (from '-90' to '90').
-
#longitude ⇒ Number
Geographical longitude of the initial search point, in degrees (from '-180' to '180').
-
#need_places ⇒ Boolean
'1' — to return location information with the check-ins.
-
#offset ⇒ Integer
Offset needed to return a specific subset of check-ins.
-
#place ⇒ Integer
Location ID of check-ins to return.
-
#timestamp ⇒ Integer
Specifies that only those check-ins created after the specified timestamp will be returned.
- #user_id ⇒ Integer
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Places::Methods::GetCheckins
|
# File 'lib/vk/api/places/methods/get_checkins.rb', line 15
|
Instance Method Details
#count ⇒ Integer
Returns Number of check-ins to return. (Ignored if 'timestamp' is not null.).
41 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 41 attribute :count, API::Types::Coercible::Int.optional.default(20) |
#friends_only ⇒ Boolean
Returns '1' — to return only check-ins with set geographical coordinates. (Ignored if 'latitude' and 'longitude' are not set.).
45 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 45 attribute :friends_only, API::Types::Form::Bool.optional.default(nil) |
#latitude ⇒ Number
Returns Geographical latitude of the initial search point, in degrees (from '-90' to '90').
31 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 31 attribute :latitude, API::Types::Coercible::Int.optional.default(nil) |
#longitude ⇒ Number
Returns Geographical longitude of the initial search point, in degrees (from '-180' to '180').
33 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 33 attribute :longitude, API::Types::Coercible::Int.optional.default(nil) |
#need_places ⇒ Boolean
Returns '1' — to return location information with the check-ins. (Ignored if 'place' is not set.);.
47 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 47 attribute :need_places, API::Types::Form::Bool.optional.default(nil) |
#offset ⇒ Integer
Returns Offset needed to return a specific subset of check-ins. (Ignored if 'timestamp' is not null.).
39 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 39 attribute :offset, API::Types::Coercible::Int.optional.default(nil) |
#place ⇒ Integer
Returns Location ID of check-ins to return. (Ignored if 'latitude' and 'longitude' are specified.).
35 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 35 attribute :place, API::Types::Coercible::Int.optional.default(nil) |
#timestamp ⇒ Integer
Returns Specifies that only those check-ins created after the specified timestamp will be returned.
43 |
# File 'lib/vk/api/places/methods/get_checkins.rb', line 43 attribute :timestamp, API::Types::Coercible::Int.optional.default(nil) |