Class: Vk::API::Friends::Methods::GetAvailableForCall

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Friends::Methods::GetAvailableForCall

Defined in:

lib/vk/api/friends/methods/get_available_for_call.rb

Overview

Returns a list of friends who can be called by the current user.

Arguments

• #fields ⇒ Array, 'bdate'

  Profile fields to return.

• #name_case ⇒ String

  Case for declension of user name and surname: ; 'nom' — nominative (default) ; 'gen' — genitive ; 'dat' — dative ; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional.

Instance Method Summary

• #initialize(arguments) ⇒ Friends::Methods::GetAvailableForCall constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :fields (Array, 'bdate') —

  Profile fields to return. Sample values: 'uid', 'first_name', 'last_name', 'nickname', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'domain', 'has_mobile', 'rate', 'contacts', 'education'.;

• :name_case (String) —

  Case for declension of user name and surname: ; 'nom' — nominative (default) ; 'gen' — genitive ; 'dat' — dative ; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional

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

Instance Method Details

#fields ⇒ Array, 'bdate'

Returns Profile fields to return. Sample values: 'uid', 'first_name', 'last_name', 'nickname', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'domain', 'has_mobile', 'rate', 'contacts', 'education'.;.

Returns:

• (Array, 'bdate') —

  Profile fields to return. Sample values: 'uid', 'first_name', 'last_name', 'nickname', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'domain', 'has_mobile', 'rate', 'contacts', 'education'.;

# File 'lib/vk/api/friends/methods/get_available_for_call.rb', line 24

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

#name_case ⇒ String

Returns Case for declension of user name and surname: ; 'nom' — nominative (default) ; 'gen' — genitive ; 'dat' — dative ; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional.

Returns:

• (String) —

  Case for declension of user name and surname: ; 'nom' — nominative (default) ; 'gen' — genitive ; 'dat' — dative ; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional

# File 'lib/vk/api/friends/methods/get_available_for_call.rb', line 26

attribute :name_case, API::Types::Coercible::String.enum("nom", "gen", "dat", "acc", "ins", "abl").optional.default("nom")