עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=streamconfigs
(main | streamconfigs)
- יחידה זו דורשת הרשאות קריאה.
- מקור: EventStreamConfig
- רישיון: GPL-2.0-or-later
חשיפת הגדרות זרם אירועים. מחזיר רק format=json עם formatversion=2.
פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
- streams
רשימת זרמים שעבורם רוצים לקבל את ההגדרות
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 250 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- constraints
סינון תוצאות לרשומות הגדרות זרם אירועים שיש להן אפשרויות כאלו
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- all_settings
- מיושן.
הכללת כל ההגדרות בתוצאות הגדרות זרם. מוכרז כמיושן מאז 1.41. כל ההגדרות כלולות בברירת המחדל.
- סוג: בוליאני (פרטים)
דוגמאות:
- קבלת הגדרות זרמים עבור רשימה של זרמים
- api.php?action=streamconfigs&streams=mediawiki.page-view|mediawiki.button-click [פתיחה בארגז חול]
- קבלת הגדרות זרמים עבור זרמים עם כל ההגדרות
- api.php?action=streamconfigs&streams=mediawiki.button-click [פתיחה בארגז חול]
- קבלת הגדרות זרם עבור זרמים שיש להם אפשרויות שמתאימות לאילוצים האלה
- api.php?action=streamconfigs&streams=mediawiki.button-click&constraints=event_service_name=eventgate-main [פתיחה בארגז חול]