Class: Vk::API::Wall::Methods::Get

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/wall/methods/get.rb

Overview

Returns a list of posts on a user wall or community wall.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Wall::Methods::Get

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.

  • :domain (String) —

    User or community short address.

  • :offset (Integer) —

    Offset needed to return a specific subset of posts.

  • :count (Integer) —

    Number of posts to return (maximum 100).

  • :filter (String) —

    Filter to apply:; 'owner' — posts by the wall owner; 'others' — posts by someone else; 'all' — posts by the wall owner and others (default); 'postponed' — timed posts (only available for calls with an 'access_token'); 'suggests' — suggested posts on a community wall

  • :extended (Boolean) —

    '1' — to return 'wall', 'profiles', and 'groups' fields; '0' — to return no additional fields (default)

  • :fields (Array) —

    @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json




# File 'lib/vk/api/wall/methods/get.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of posts to return (maximum 100).

Returns:

  • (Integer) —

    Number of posts to return (maximum 100).



35
 
# File 'lib/vk/api/wall/methods/get.rb', line 35

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

#domain ⇒ String

Returns User or community short address.

Returns:

  • (String) —

    User or community short address.



31
 
# File 'lib/vk/api/wall/methods/get.rb', line 31

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

#extended ⇒ Boolean

Returns '1' — to return 'wall', 'profiles', and 'groups' fields; '0' — to return no additional fields (default).

Returns:

  • (Boolean) —

    '1' — to return 'wall', 'profiles', and 'groups' fields; '0' — to return no additional fields (default)



39
 
# File 'lib/vk/api/wall/methods/get.rb', line 39

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

#fields ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:



41
 
# File 'lib/vk/api/wall/methods/get.rb', line 41

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

#filter ⇒ String

Returns Filter to apply:; 'owner' — posts by the wall owner; 'others' — posts by someone else; 'all' — posts by the wall owner and others (default); 'postponed' — timed posts (only available for calls with an 'access_token'); 'suggests' — suggested posts on a community wall.

Returns:

  • (String) —

    Filter to apply:; 'owner' — posts by the wall owner; 'others' — posts by someone else; 'all' — posts by the wall owner and others (default); 'postponed' — timed posts (only available for calls with an 'access_token'); 'suggests' — suggested posts on a community wall



37
 
# File 'lib/vk/api/wall/methods/get.rb', line 37

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of posts.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of posts.



33
 
# File 'lib/vk/api/wall/methods/get.rb', line 33

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

#owner_id ⇒ Integer

Returns ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.

Returns:

  • (Integer) —

    ID of the user or community that owns the wall. By default, current user ID. Use a negative value to designate a community ID.



29
 
# File 'lib/vk/api/wall/methods/get.rb', line 29

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