Class: Vk::API::Board::Methods::GetTopics
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Board::Methods::GetTopics
- Defined in:
- lib/vk/api/board/methods/get_topics.rb
Overview
Returns a list of topics on a community's discussion board.
Arguments collapse
-
#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).
-
#group_id ⇒ Integer
ID of the community that owns the discussion board.
-
#offset ⇒ Integer
Offset needed to return a specific subset of topics.
-
#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.
-
#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.
-
#topic_ids ⇒ Array
IDs of topics to be returned (100 maximum).
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
permalink #initialize(arguments) ⇒ Board::Methods::GetTopics
|
# File 'lib/vk/api/board/methods/get_topics.rb', line 15
|
Instance Method Details
permalink #count ⇒ Integer
Returns 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) |
permalink #extended ⇒ Boolean
Returns '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) |
permalink #group_id ⇒ Integer
Returns 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 |
permalink #offset ⇒ Integer
Returns 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) |
permalink #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.
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) |
permalink #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'.
42 |
# File 'lib/vk/api/board/methods/get_topics.rb', line 42 attribute :preview, API::Types::Coercible::Int.optional.default(nil) |
permalink #preview_length ⇒ Integer
Returns 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) |
permalink #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.
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) |