راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی
این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.
مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
prop=info (in)
- این پودمان نیازمند اختیارات خواندن است.
- منبع: MediaWiki
- مجوز: GPL-2.0-or-later
دریافت اطلاعات سادهٔ صفحه.
- inprop
Which additional properties to get:
- protection
- List the protection level of each page.
- talkid
- The page ID of the talk page for each non-talk page.
- watched
- List the watched status of each page.
- watchers
- The number of watchers, if allowed.
- visitingwatchers
- The number of watchers of each page who have visited recent edits to that page, if allowed.
- notificationtimestamp
- The watchlist notification timestamp of each page.
- subjectid
- The page ID of the parent page for each talk page.
- associatedpage
- The prefixed title of the associated subject or talk page.
- url
- Gives a full URL, an edit URL, and the canonical URL for each page.
- readable
- منسوخ‌شده. Whether the user can read this page. Use intestactions=read instead.
- preload
- Gives the text returned by EditFormPreloadText.
- displaytitle
- Gives the manner in which the page title is actually displayed.
- varianttitles
- Gives the display title in all variants of the site content language.
- linkclasses
- Gives the additional CSS classes (e.g. link colors) used for links to this page if they were to appear on the page named by inlinkcontext.
- مقدارهای (جداشده با | یا جایگزین‌های آن): associatedpage، displaytitle، linkclasses، notificationtimestamp، preload، protection، subjectid، talkid، url، varianttitles، visitingwatchers، watched، watchers، readable
- inlinkcontext
The context title to use when determining extra CSS classes (e.g. link colors) when inprop contains linkclasses.
- نوع: عنوان صفحه
- صفحه‌های ناموجود را می‌پذیرد
- پیش‌فرض: صفحهٔ اصلی
- intestactions
Test whether the current user can perform certain actions on the page.
- Separate values with | or alternative.
- حداکثر تعداد مقدارها ۵۰ است (۵۰۰ برای متقضایانی که مجوز محدودیت‌های بالاتر را دارند).
- intestactionsdetail
Detail level for intestactions. Use the main module's errorformat and errorlang parameters to control the format of the messages returned.
- boolean
- Return a boolean value for each action.
- full
- Return messages describing why the action is disallowed, or an empty array if it is allowed.
- quick
- Like full but skipping expensive checks.
- یکی از مقدارهای زیر: boolean، full، quick
- پیش‌فرض: boolean
- incontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Get information about the page Main Page.
- api.php?action=query&prop=info&titles=Main%20Page [باز کردن در صفحهٔ تمرین]
- Get general and protection information about the page Main Page.
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [باز کردن در صفحهٔ تمرین]
list=categorymembers (cm)
- این پودمان نیازمند اختیارات خواندن است.
- This module can be used as a generator.
- منبع: MediaWiki
- مجوز: GPL-2.0-or-later
فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.
- cmtitle
Which category to enumerate (required). Must include the رده: prefix. Cannot be used together with cmpageid.
- cmpageid
Page ID of the category to enumerate. Cannot be used together with cmtitle.
- نوع: عدد صحیح
- cmprop
Which pieces of information to include:
- ids
- افزودن شناسه صفحه
- title
- Adds the title and namespace ID of the page.
- sortkey
- Adds the sortkey used for sorting in the category (hexadecimal string).
- sortkeyprefix
- Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
- type
- Adds the type that the page has been categorised as (page, subcat or file).
- timestamp
- Adds the timestamp of when the page was included.
- مقدارهای (جداشده با | یا جایگزین‌های آن): ids، sortkey، sortkeyprefix، timestamp، title، type
- پیش‌فرض: ids|title
- cmnamespace
Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.
- مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- برای تعیین همهٔ مقدارها از * استفاده کنید.
- cmtype
Which type of category members to include. Ignored when cmsort=timestamp is set.
- مقدارهای (جداشده با | یا جایگزین‌های آن): file، page، subcat
- پیش‌فرض: page|subcat|file
- cmcontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- cmlimit
The maximum number of pages to return.
- نوع: عدد صحیح یا max
- The value must be between ۱ and ۵۰۰.
- پیش‌فرض: 10
- cmsort
ویژگی برای مرتب‌سازی
- یکی از مقدارهای زیر: sortkey، timestamp
- پیش‌فرض: sortkey
- cmdir
جهت مرتب شدن
- یکی از مقدارهای زیر: asc، ascending، desc، descending، newer، older
- پیش‌فرض: ascending
- cmstart
Timestamp to start listing from. Can only be used with cmsort=timestamp.
- نوع: برچسب زمان (قالب‌های مجاز)
- cmend
Timestamp to end listing at. Can only be used with cmsort=timestamp.
- نوع: برچسب زمان (قالب‌های مجاز)
- cmstarthexsortkey
Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmendhexsortkey
Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmstartsortkeyprefix
Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.
- cmendsortkeyprefix
Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.
- cmstartsortkey
- منسوخ‌شده.
جایش از cmstarthexsortkey استفاده کنید.
- cmendsortkey
- منسوخ‌شده.
Use cmendhexsortkey instead.
- Get first 10 pages in Category:Physics.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [باز کردن در صفحهٔ تمرین]
- Get page info about first 10 pages in Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [باز کردن در صفحهٔ تمرین]