Class: Vk::API::Newsfeed::Methods::GetBanned

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

Overview

Returns a list of users and communities banned from the current user's newsfeed.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Newsfeed::Methods::GetBanned

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :extended (Boolean) —

    '1' — return extra information about users and communities

  • :fields (Array) —

    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




# File 'lib/vk/api/newsfeed/methods/get_banned.rb', line 15

Instance Method Details

#extended ⇒ Boolean

Returns '1' — return extra information about users and communities.

Returns:

  • (Boolean) —

    '1' — return extra information about users and communities



25
 
# File 'lib/vk/api/newsfeed/methods/get_banned.rb', line 25

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

#fields ⇒ Array

Returns Profile fields to return.; ;.

Returns:

  • (Array) —

    Profile fields to return.; ;



27
 
# File 'lib/vk/api/newsfeed/methods/get_banned.rb', line 27

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



29
 
# File 'lib/vk/api/newsfeed/methods/get_banned.rb', line 29

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