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
action=collection
(main | collection)
- Este módulo é interno ou instável, e não deve ser usado. O funcionamento do mesmo pode ser alterado sem aviso prévio.
- Este módulo requer direitos de leitura.
- Fonte: Collection
- Licença: GPL-2.0-or-later
Módulo da API para realizar várias operações na coleção de um utilizador da wiki.
Parâmetro específico:
Estão disponíveis outros parâmetros gerais.
- submodule
Submódulo para realizar várias operações na coleção de um utilizador da wiki.
- addarticle
- Módulo da API para adicionar uma página à coleção
- addcategory
- Módulo da API para adicionar páginas de uma dada categoria à coleção de um utilizador.
- addchapter
- Módulo da API para adicionar um capítulo à coleção
- clearcollection
- Módulo da API para limpar a coleção e as sugestões
- getbookcreatorboxcontent
- Submódulo da API para extrair o conteúdo de caixa da página especial da caixa do criador de livros do utilizador.
- getcollection
- Módulo da API para listar as páginas presentes de uma coleção
- getpopupdata
- Módulo da API para obter dados e HTML para construir uma janela flutuante
- postcollection
- Módulo da API para publicar páginas na coleção de um utilizador
- removearticle
- Módulo da API para remover uma página da coleção
- removeitem
- Módulo da API para remover o elemento da coleção com base num índice através da página Especial:Criar livros.
- renamechapter
- Módulo da API para alterar o nome de um capítulo na coleção do utilizador
- setsorting
- Módulo da API para reordenar elementos de uma coleção
- settitles
- Módulo da API para definir o título, o subtítulo e as configurações da coleção
- sortitems
- Módulo da API para ordenar as páginas de uma coleção alfabeticamente. As páginas em capítulos são agrupadas e ordenadas em conjunto.
- suggestarticleaction
- Módulo da API para interagir com sugestões
- suggestundoarticleaction
- Módulo da API para desfazer operações feitas de 'suggestarticleaction'
- Este parâmetro é obrigatório.
- Um dos seguintes valores: addarticle, addcategory, addchapter, clearcollection, getbookcreatorboxcontent, getcollection, getpopupdata, postcollection, removearticle, removeitem, renamechapter, setsorting, settitles, sortitems, suggestarticleaction, suggestundoarticleaction
Exemplo:
- Submódulo para realizar várias operações na coleção de um utilizador da wiki.
- api.php?action=collection&submodule=getcollection [abrir na página de testes]