راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی
این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده است.
مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=block
- این پودمان نیازمند اختیارات خواندن است.
- این پودمان نیازمند اختیارات خواندن است.
- این پودمان تنها درخواست‌های POST را می‌پذیرد.
- منبع: MediaWiki
- مجوز: GPL-2.0-or-later
بستن یک کاربر.
- id
شناسهٔ قطع دسترسی برای تغییر (به‌دست‌آمده از طریق list=blocks). نمی‌تواند همراه با user، reblock یا newblock استفاده شود.
- نوع: عدد صحیح
- user
کاربری که باید قطع دسترسی شود. نمی‌تواند همراه با id استفاده شود.
- نوع: کاربر، توسط هریک از نام کاربری، آی‌پی، حساب کاربری موقت، بازهٔ آی‌پی و شناسهٔ کاربر (مثلاً «#12345»)
- userid
- منسوخ‌شده.
در عوض user=#شناسه را تعریف کنید.
- نوع: عدد صحیح
- expiry
زمان منقضی‌شدن. می‌تواند نسبی (برای مثال، 5 months or 2 weeks) یا دقیق (برای مثال، 2014-09-18T12:34:56Z) باشد. اگر بر روی infinite، indefinite یا never تنظیم شود، قطع دسترسی هرگز منقضی نخواهد شد.
- پیش‌فرض: never
- reason
دلیل برای بستن
- پیش‌فرض: (خالی)
- anononly
فقط قطع دسترسی کاربران ناشناس (یعنی غیرفعال کردن ویرایش‌های ناشناس برای این نشانی IP، شامل ویرایش‌های حساب موقت).
- نوع: بولی (جزئیات)
- nocreate
جلوگیری از ایجاد حساب.
- نوع: بولی (جزئیات)
- autoblock
به طور خودکار آخرین نشانی آی‌پی استفاده‌شده، و هر نشانی پس از آن که سعی می‌کند از آن داخل شود را ببند.
- نوع: بولی (جزئیات)
- noemail
از کاربر در برابر ارسال ایمیل از طریق ویکی جلوگیری شود. (نیازمند دسترسی
blockemailاست).- نوع: بولی (جزئیات)
- hidename
نام کاربری را از سیاههٔ بستن پنهان کن. (نیازمند دسترسی
hideuserاست).- نوع: بولی (جزئیات)
- allowusertalk
اجازه‌دادن به کاربر برای ویرایش صفحهٔ بحث خودش (وابسته به $wgBlockAllowsUTEdit).
- نوع: بولی (جزئیات)
- reblock
اگر کاربر از قبل تنها یک قطع دسترسی داشته باشد، قطع دسترسی موجود بازنویسی می‌شود. اگر کاربر بیش از یک بار قطع دسترسی شده باشد، این اقدام ناموفق خواهد بود—به جای آن از پارامتر id استفاده کنید تا مشخص شود کدام قطع دسترسی باید بازنویسی شود. نمی‌تواند همراه با id یا newblock استفاده شود.
- نوع: بولی (جزئیات)
- newblock
افزودن یک قطع دسترسی دیگر حتی اگر دسترسی کاربر از قبل قطع شده باشد. نمی‌تواند همراه با id یا reblock استفاده شود.
- نوع: بولی (جزئیات)
- watchuser
پیگیری صفحه‌های کاربری و بحث کاربری کاربر یا نشانی آی‌پی.
- نوع: بولی (جزئیات)
برچسب‌های تغییر به‌منظور اعمال به مدخل سیاههٔ قطع دسترسی.
- مقدارهای (جداشده با | یا جایگزین‌های آن):
- partial
قطع دسترسی کاربر از صفحه‌ها یا فضاهای نام خاص به‌جای قطع دسترسی کلی از وبگاه.
- نوع: بولی (جزئیات)
- pagerestrictions
فهرست عنوان‌ها برای قطع دسترسی ویرایشی کاربر در آن‌ها. تنها زمانی قابل اعمال است که partial روی true تنظیم شده باشد.
- نوع: عنوان صفحه
- Separate values with | or alternative.
- Maximum number of values is ۱۰.
- تنها صفحه‌های موجود را می‌پذیرد
- namespacerestrictions
فهرست فضاهای نام برای قطع دسترسی ویرایشی کاربر در آن‌ها. تنها زمانی قابل اعمال است که partial روی true تنظیم شده باشد.
- مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- برای تعیین همهٔ مقدارها از * استفاده کنید.
- actionrestrictions
فهرست کنش‌ها برای قطع دسترسی کاربر از انجام آن‌ها. تنها در صورتی قابل اعمال است که partial روی true تنظیم شده باشد.
- مقدارهای (جداشده با | یا جایگزین‌های آن): create، move، upload
- token
یک بلیط «csrf» واکشی‌شده از action=query&meta=tokens
- این پارامتر الزامی است.
- قطع دسترسی آی‌پی ۱۹۲٫۰٫۲٫۵ برای سه روز به‌همراه دلیل.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [باز کردن در صفحهٔ تمرین]
- بستن کاربر خرابکار به شکل نامحدود به‌همراه دلیل، همچنين جلوگيری از ايجاد حساب جديد و ارسال ايميل.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [باز کردن در صفحهٔ تمرین]