Class: Vk::API::Board::Methods::GetTopics

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

Overview

Returns a list of topics on a community's discussion board.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Board::Methods::GetTopics

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer) —

    ID of the community that owns the discussion board.

  • :topic_ids (Array) —

    IDs of topics to be returned (100 maximum). By default, all topics are returned.; ; If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.

  • :order (Integer) —

    Sort order:; '1' — by date updated in reverse chronological order.; '2' — by date created in reverse chronological order.; '-1' — by date updated in chronological order.; '-2' — by date created in chronological order.; ; If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.

  • :offset (Integer) —

    Offset needed to return a specific subset of topics.

  • :count (Integer) —

    Number of topics to return.

  • :extended (Boolean) —

    '1' — to return information about users who created topics or who posted there last; '0' — to return no additional fields (default)

  • :preview (Integer) —

    '1' — to return the first comment in each topic;; '2' — to return the last comment in each topic;; '0' — to return no comments.; ; By default: '0'.

  • :preview_length (Integer) —

    Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.




# File 'lib/vk/api/board/methods/get_topics.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of topics to return.

Returns:

  • (Integer) —

    Number of topics to return.



38
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 38

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

#extended ⇒ Boolean

Returns '1' — to return information about users who created topics or who posted there last; '0' — to return no additional fields (default).

Returns:

  • (Boolean) —

    '1' — to return information about users who created topics or who posted there last; '0' — to return no additional fields (default)



40
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 40

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

#group_id ⇒ Integer

Returns ID of the community that owns the discussion board.

Returns:

  • (Integer) —

    ID of the community that owns the discussion board.



30
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 30

attribute :group_id, API::Types::Coercible::Int

#offset ⇒ Integer

Returns Offset needed to return a specific subset of topics.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of topics.



36
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 36

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

#order ⇒ Integer

Returns Sort order:; '1' — by date updated in reverse chronological order.; '2' — by date created in reverse chronological order.; '-1' — by date updated in chronological order.; '-2' — by date created in chronological order.; ; If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.

Returns:

  • (Integer) —

    Sort order:; '1' — by date updated in reverse chronological order.; '2' — by date created in reverse chronological order.; '-1' — by date updated in chronological order.; '-2' — by date created in chronological order.; ; If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.



34
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 34

attribute :order, API::Types::Coercible::Int.enum("1", "2", "-1", "-2").optional.default(nil)

#preview ⇒ Integer

Returns '1' — to return the first comment in each topic;; '2' — to return the last comment in each topic;; '0' — to return no comments.; ; By default: '0'.

Returns:

  • (Integer) —

    '1' — to return the first comment in each topic;; '2' — to return the last comment in each topic;; '0' — to return no comments.; ; By default: '0'.



42
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 42

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

#preview_length ⇒ Integer

Returns Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.

Returns:

  • (Integer) —

    Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.



44
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 44

attribute :preview_length, API::Types::Coercible::Int.optional.default(90)

#topic_ids ⇒ Array

Returns IDs of topics to be returned (100 maximum). By default, all topics are returned.; ; If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.

Returns:

  • (Array) —

    IDs of topics to be returned (100 maximum). By default, all topics are returned.; ; If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.



32
 
# File 'lib/vk/api/board/methods/get_topics.rb', line 32

attribute :topic_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)