Class: Vk::API::Places::Methods::Checkin

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/places/methods/checkin.rb

Overview

Checks a user in at the specified location.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Places::Methods::Checkin

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :place_id (Integer) —

    Location ID.

  • :text (String) —

    Text of the comment on the check-in (255 characters maximum; line breaks not supported).

  • :latitude (Number) —

    Geographical latitude of the check-in, in degrees (from '-90' to '90').

  • :longitude (Number) —

    Geographical longitude of the check-in, in degrees (from '-180' to '180').

  • :friends_only (Boolean) —

    '1' — Check-in will be available only for friends.; '0' — Check-in will be available for all users (default).

  • :services (Array) —

    List of services or websites (e.g., 'twitter', 'facebook') to which the check-in will be exported, if the user has set up the respective option.




# File 'lib/vk/api/places/methods/checkin.rb', line 15

Instance Method Details

#friends_only ⇒ Boolean

Returns '1' — Check-in will be available only for friends.; '0' — Check-in will be available for all users (default).

Returns:

  • (Boolean) —

    '1' — Check-in will be available only for friends.; '0' — Check-in will be available for all users (default).



36
 
# File 'lib/vk/api/places/methods/checkin.rb', line 36

attribute :friends_only, API::Types::Form::Bool.optional.default(nil)

#latitude ⇒ Number

Returns Geographical latitude of the check-in, in degrees (from '-90' to '90').

Returns:

  • (Number) —

    Geographical latitude of the check-in, in degrees (from '-90' to '90').



32
 
# File 'lib/vk/api/places/methods/checkin.rb', line 32

attribute :latitude, API::Types::Coercible::Int.optional.default(nil)

#longitude ⇒ Number

Returns Geographical longitude of the check-in, in degrees (from '-180' to '180').

Returns:

  • (Number) —

    Geographical longitude of the check-in, in degrees (from '-180' to '180').



34
 
# File 'lib/vk/api/places/methods/checkin.rb', line 34

attribute :longitude, API::Types::Coercible::Int.optional.default(nil)

#place_id ⇒ Integer

Returns Location ID.

Returns:

  • (Integer) —

    Location ID.



28
 
# File 'lib/vk/api/places/methods/checkin.rb', line 28

attribute :place_id, API::Types::Coercible::Int.optional.default(nil)

#services ⇒ Array

Returns List of services or websites (e.g., 'twitter', 'facebook') to which the check-in will be exported, if the user has set up the respective option.

Returns:

  • (Array) —

    List of services or websites (e.g., 'twitter', 'facebook') to which the check-in will be exported, if the user has set up the respective option.



38
 
# File 'lib/vk/api/places/methods/checkin.rb', line 38

attribute :services, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#text ⇒ String

Returns Text of the comment on the check-in (255 characters maximum; line breaks not supported).

Returns:

  • (String) —

    Text of the comment on the check-in (255 characters maximum; line breaks not supported).



30
 
# File 'lib/vk/api/places/methods/checkin.rb', line 30

attribute :text, API::Types::Coercible::String.optional.default(nil)