Interface BoardGetTopicsParams

interface BoardGetTopicsParams {
    count?: number;
    extended?: number | boolean;
    group_id: number;
    offset?: number;
    order?: 0 | 2 | 1 | -1 | -2;
    preview?: 0 | 2 | 1;
    preview_length?: number;
    topic_ids?: number | number[];
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

count? extended? group_id offset? order? preview? preview_length? topic_ids?

Properties

Optional count

count?: number

Number of topics to return.

Optional extended

extended?: number | boolean

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

group_id

group_id: number

ID of the community that owns the discussion board.

Optional offset

offset?: number

Offset needed to return a specific subset of topics.

Optional order

order?: 0 | 2 | 1 | -1 | -2

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.

Optional preview

preview?: 0 | 2 | 1

'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'.

Optional preview_length

preview_length?: number

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

Optional topic_ids

topic_ids?: number | number[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc