Contents

# frozen_string_literal: true
require 'vk/api/methods'

module Vk
  module API
    class Friends < Vk::Schema::Namespace
      module Methods
        # Returns a list of the current user's friends whose phone numbers, validated or specified in a profile, are in a given list.
        class GetByPhones < Schema::Method
          # @!group Properties

          self.open = false
          self.method = 'friends.getByPhones'

          # @method initialize(arguments)
          #   @param [Hash] arguments
          #   @option arguments [Array] :phones List of phone numbers in MSISDN format (maximum 1000).; Example:; "[phone],[phone]"
          #   @option arguments [Array, 'bdate'] :fields Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online, counters'.;
          #   @return [Friends::Methods::GetByPhones]

          # @!group Arguments

          # @return [Array] List of phone numbers in MSISDN format (maximum 1000).; Example:; "[phone],[phone]"
          attribute :phones, API::Types::Coercible::Array.optional
          # @return [Array, 'bdate'] Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online, counters'.;
          attribute :fields, API::Types::Coercible::Array.optional
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vk-0.99.5.53.alpha	lib/vk/api/friends/methods/get_by_phones.rb