Extension:LiquidThreads/API

From MediaWiki.org
Jump to: navigation, search

LiquidThreads adds a 'threads' list module to retrieve thread details.

Parameters

  • thstartid: The thread id to start enumerating from
  • thendid: The thread id to stop enumerating at
  • thdir: The direction in which to enumerate (older, newer)
  • thshowdeleted: Whether or not to show deleted threads.
  • thlimit: The maximum number of threads to list
  • thprop: Which properties to get
  • thpage: Limit results to threads on a particular page(s)
  • thauthor: Limit results to threads by a particular author(s)
  • throot: Limit results to threads with the given root(s)
  • thsummary: Limit results to threads corresponding to the given summary page(s)
  • thid: Get threads with the given ID(s)
  • thrender: Whether to include the rendered thread in the results.
  • threnderlevel: When rendering, the level at which to start (for the sake of depth limits, etc.).
  • threnderthreadpos: When rendering, the position of the thread in the group of threads being rendered at that level (affects display somewhat).
  • threnderthreadcount: When rendering, the number of threads in that level group.
  • threndermaxthreadcount: When rendering, the maximum number of replies to show before adding a "Show more replies" link.
  • threndermaxdepth: When rendering, the maximum depth of replies to show before showing a "Show X replies" link instead of replies.
  • threnderstartrepliesat: When rendering, the point at which to start showing replies (used internally to load extra replies).

Example Get details of all threads on "Talk:Xpd" page.

Feedthreads[edit]

This module returns a feed of discussion threads

Parameters[edit]

  • days – Number of days of threads to show. Type: integer
  • feedformat – The format of the feed.
Type: one of rss, atom
  • talkpage – Limit results to threads on these talk pages.
  • thread – Limit results to these threads and their descendants.
  • type – Types of posts to show.
Type: one of replies, newthreads



action=feedthreads

(main | feedthreads)
  • This module requires read rights.
  • Source: Liquid Threads
  • License: GPL-2.0+

Return a feed of discussion threads.

Parameters:
feedformat

The format of the feed.

One of the following values: rss, atom
Default: rss
days

Number of days of threads to show.

The value must be between 1 and 30.
Type: integer
Default: 7
type

Types of posts to show.

Values (separate with | or alternative): replies, newthreads
Default: newthreads
talkpage

Limit results to threads on these talk pages.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
thread

Limit results to these threads and their descendants.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).

Threadaction[edit]



action=threadaction

(main | threadaction)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: Liquid Threads
  • License: GPL-2.0+

Allows actions to be taken on threads and posts in threaded discussions.

Parameters:
thread

Thread IDs or titles to act on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
talkpage

The talkpage to act on (if applicable).

threadaction

The action to take.

This parameter is required.
One of the following values: markread, markunread, split, merge, reply, newthread, setsubject, setsortkey, edit, addreaction, deletereaction, inlineeditform
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
subject

The subject to set for the new or split thread.

reason

If applicable, the reason/summary for the action.

newparent

If merging a thread, the ID or title for its new parent.

text

The text of the post to create.

render

On post and reply methods, the top-level thread after the change will be rendered and returned in the result.

bump

Overrides default behavior as to whether or not to.

sortkey

Specifies the timestamp to which to set a thread's sort key. May be "now".

signature

Specifies the signature to use for that post, instead of the default.

type

Specifies the type of reaction to add.

value

Specifies the value associated with the reaction to add.

method

For getting inline edit forms, the method to get a form for.

operand
(no description)
captchaword

Answer to the CAPTCHA

captchaid

CAPTCHA ID from previous request