עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

meta=messagegroups (mg)

(main | query | messagegroups)
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: Translate
  • רישיון: GPL-2.0-or-later

החזרת מידע על קבוצות של הודעות.

יש לשים לב לכך שהפרמטר uselang משפיע על הפלט של החלקים התלויים בשפה.

פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
mgdepth

בעת שימוש בתסדיר עץ, להגביל את העומק למספר כזה של רמות. ערך 0 אומר שלא תוצג שום קבוצת־משנה. אם המגבלה מושגת, הפלט כולל ערך "groupcount", שמציין את מספר הילדים הישיר.

סוג: מספר שלם
ברירת המחדל: 100
mgfilter

להחזיר רק הודעות עם מזהים שמתאימים לאחד מהקלטים שניתנו (אינו תלוי־רישיות, מופרד בתווי קו ניצב, תו־כול *).

הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
ברירת מחדל: (ריק)
mgformat

בתסדיר עץ קבוצות הודעות יכולות להתקיים במקומות מרובים בעץ.

אחד מהערכים הבאים: flat, tree
ברירת המחדל: flat
mgiconsize

גודל מועדף של סמל קבוצה רשתי.

סוג: מספר שלם
ברירת המחדל: 64
mgprop

איזה מידע על תרגום לקבל:

id
לכלול את המזהה של הקבוצה.
label
לכלול את התווית של הקבוצה.
description
לכלול את התיאור של הקבוצה.
class
לכלול את שם המחלקה של הקבוצה.
namespace
לכלול את מרחב השם של הקבוצה. לא כל הקבוצות שייכות למרחב שם אחד.
exists
לכלול את מאפיין הקיום המחושב עצמית של הקבוצה.
icon
לכלול את ה־URL־ים לסמל של הקבוצה.
priority
לכלול מצב עדיפות, כמו "לא מומלץ".
prioritylangs
לכלול שפות מועדפות. אם זה לא מוגדר, יוחזר false.
priorityforce
לכלול מצב עדיפות – האם השפות המועדפות כפויות.
workflowstates
לכלול את מצבי זרימת העבודה עבור קבוצת ההודעות.
sourcelanguage
לכלול את שפת המקור עבור הקבוצה.
subscription
לכלול האם המשתמש מנוי על הקבוצה.
ערכים (מופרדים באמצעות "|" או or תו חלופי): class, description, exists, icon, id, label, namespace, priority, priorityforce, prioritylangs, sourcelanguage, subscription, workflowstates
ברירת המחדל: id|label|description|class|exists
mgroot

בעת שימוש בתסדיר עץ, במקום להתחיל מהרמה העליונה, להתחיל מקבוצת ההודעות הנתונה, שצריכה להיות קבוצת הודעות משולבת. בעת שימוש בתסדיר שטוח רק הקבוצה שצוינה תוחזר.

ברירת מחדל: (ריק)
mglanguageFilter

להחזיר רק קבוצות הודעות שאפשר לתרגם לשפה הנתונה.

ברירת מחדל: (ריק)
דוגמה:
להציג קבוצות הודעות
api.php?action=query&meta=messagegroups [פתיחה בארגז חול]