Class: Vk::API::Notifications::Methods::Get

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

Overview

Returns a list of notifications about other users' feedback to the current user's wall posts.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :count (Integer) —

    Number of notifications to return.

  • :start_from (String) —

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

  • :filters (Array) —

    Type of notifications to return:; 'wall' — wall posts; 'mentions' — mentions in wall posts, comments, or topics; 'comments' — comments to wall posts, photos, and videos; 'likes' — likes; 'reposted' — wall posts that are copied from the current user's wall; 'followers' — new followers; 'friends' — accepted friend requests

  • :start_time (Integer) —

    Earliest timestamp (in Unix time) of a notification to return. By default, 24 hours ago.

  • :end_time (Integer) —

    Latest timestamp (in Unix time) of a notification to return. By default, the current time.




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

Instance Method Details

#count ⇒ Integer

Returns Number of notifications to return.

Returns:

  • (Integer) —

    Number of notifications to return.



27
 
# File 'lib/vk/api/notifications/methods/get.rb', line 27

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

#end_time ⇒ Integer

Returns Latest timestamp (in Unix time) of a notification to return. By default, the current time.

Returns:

  • (Integer) —

    Latest timestamp (in Unix time) of a notification to return. By default, the current time.



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

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

#filters ⇒ Array

Returns Type of notifications to return:; 'wall' — wall posts; 'mentions' — mentions in wall posts, comments, or topics; 'comments' — comments to wall posts, photos, and videos; 'likes' — likes; 'reposted' — wall posts that are copied from the current user's wall; 'followers' — new followers; 'friends' — accepted friend requests.

Returns:

  • (Array) —

    Type of notifications to return:; 'wall' — wall posts; 'mentions' — mentions in wall posts, comments, or topics; 'comments' — comments to wall posts, photos, and videos; 'likes' — likes; 'reposted' — wall posts that are copied from the current user's wall; 'followers' — new followers; 'friends' — accepted friend requests



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

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

#start_from ⇒ String

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

Returns:



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

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

#start_time ⇒ Integer

Returns Earliest timestamp (in Unix time) of a notification to return. By default, 24 hours ago.

Returns:

  • (Integer) —

    Earliest timestamp (in Unix time) of a notification to return. By default, 24 hours ago.



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

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