Ajuda da API do MediaWiki

Esta é uma página de documentação da API do MediaWiki gerada automaticamente.

Documentação e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

meta=readinglists (rl)

(main | query | readinglists)
  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Fonte: ReadingLists
  • Licença: GPL-2.0-or-later

Listar ou filtrar as listas de leitura do utilizador e mostrar metadados sobre elas.

Este módulo tem quatro modos de operação. Com o parâmetro rllist, devolve informação acerca da lista especificada. Com o parâmetro rlchangedsince (alteradas desde), devolve todas as listas do utilizador corrente alteradas após a data fornecida. (Este modo destina-se à sincronização de dispositivos e, ao contrário dos restantes, inclui listas eliminadas. Só são consideradas as alterações aos metadados das listas, não às entradas das listas.) Com os parâmetros rlproject (projeto) e rltitle (título), ele devolve todas as listas que incluem essa página. Sem nenhum destes parâmetros, devolve todas as listas.

Parâmetros:
Other general parameters are available.
rllist

Identificador de lista.

Tipo: inteiro
O valor não pode ser inferior a 1.
rlproject

Projeto da página a filtrar. Tem de ser usado em conjunto com rltitle. Só devolve listas que incluem este projeto e este título.

rltitle

Título da página a filtrar. Tem de ser usado em conjunto com rlproject. Só devolve listas que incluem este projeto e este título.

rlchangedsince

Mostrar as listas que foram alteradas após esta data e hora. Tem de ser posterior a 2024-04-18T08:32:18Z. Os clientes devem utilizar a data e hora devolvidas no campo readinglists-synctimestamp de uma chamada anterior, se quiserem garantir que nenhuma alteração seja perdida, e devem estar preparados para receber as alterações que já foram devolvidas numa resposta anterior, e lidar com elas de um modo idempotente.

Tipo: data e hora (formatos permitidos)
rlsort

Propriedade pela qual ordenar. Ignorado quando rlproject e rltitle está definido (resultados são devolvidos pela ordem na BD). Por omissão, é updated quando rlchangedsince está definido, e name quando não está.

name
Nome da lista (o ordenamento é por valor binário; por exemplo, qualquer carácter ASCII maiúsculo será listado antes de qualquer minúsculo).
updated
Data e hora da última atualização (nas atualizações incluem-se mudanças aos metadados da lista mas não se incluem mudanças aos elementos da lista).
Um dos seguintes valores: name, updated
rldir

Direção de ordenação: ascending (ascendente, de A a Z, do mais antigo ao mais recente) ou descending (descendente). Ignorado quando rlproject e rltitle estão definidos.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
rllimit

O número de resultados a serem devolvidos.

Tipo: inteiro ou max
O valor tem de estar entre 1 e 10.
Valor por omissão: 10
rlcontinue

Quando houver mais resultados disponíveis, usar isto para continuar. Podem ser encontradas na wiki mediawiki.org mais informações sobre a aplicação da continuação a consultas.

Exemplos:
Obter as listas de leitura do utilizador corrente.
api.php?action=query&meta=readinglists [abrir na página de testes]
Obter as listas de leitura do utilizador corrente que tenham sido alteradas após 2013-01-01T00:00:00Z.
api.php?action=query&meta=readinglists&rlchangedsince=2013-01-01T00:00:00Z [abrir na página de testes]
Obter as listas de leitura do utilizador corrente que contenham a página Dog do projeto en.wikipedia.org
api.php?action=query&meta=readinglists&rlproject=https%3A%2F%2Fen.wikipedia.org&rltitle=Dog [abrir na página de testes]