Class: Vk::API::Friends::Methods::GetOnline

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/friends/methods/get_online.rb

Overview

Returns a list of user IDs of a user's friends who are online.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Friends::Methods::GetOnline

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_id (Integer) —

    User ID.

  • :list_id (Integer) —

    Friend list ID. If this parameter is not set, information about all online friends is returned.

  • :online_mobile (Boolean) —

    '1' — to return an additional 'online_mobile' field; '0' — (default);

  • :order (String) —

    Sort order:; 'random' — random order

  • :count (Integer) —

    Number of friends to return.

  • :offset (Integer) —

    Offset needed to return a specific subset of friends.




# File 'lib/vk/api/friends/methods/get_online.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of friends to return.

Returns:

  • (Integer) —

    Number of friends to return.



36
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 36

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

#list_id ⇒ Integer

Returns Friend list ID. If this parameter is not set, information about all online friends is returned.

Returns:

  • (Integer) —

    Friend list ID. If this parameter is not set, information about all online friends is returned.



30
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 30

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of friends.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of friends.



38
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 38

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

#online_mobile ⇒ Boolean

Returns '1' — to return an additional 'online_mobile' field; '0' — (default);.

Returns:

  • (Boolean) —

    '1' — to return an additional 'online_mobile' field; '0' — (default);



32
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 32

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

#order ⇒ String

Returns Sort order:; 'random' — random order.

Returns:

  • (String) —

    Sort order:; 'random' — random order



34
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 34

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

#user_id ⇒ Integer

Returns User ID.

Returns:

  • (Integer) —

    User ID.



28
 
# File 'lib/vk/api/friends/methods/get_online.rb', line 28

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