mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-12-18 10:52:27 +00:00
e27f4937ff
Allows users to send notifications to themselves (T306211). For sending notifications to others, a new permission is created (echo-create), assigned only to bots by default. For now, only one user can be notified in one API request. If the email flag is set in the API params, the notification is also sent as an email, provided the user hasn't disabled email notifications for the "api-triggered" category. This feature is behind a feature flag. Set $wgEchoEnableApiEvents = true to use. Adapted from If0267a38be7d454e3d284d30f93c93a828288dd7. Co-authored-by: TheresNoTime <starling-ctr@wikimedia.org> Bug: T58362 Bug: T306211 Change-Id: I94642bff5dcb075cb9db862206d59c19edad9fd1
94 lines
8.8 KiB
JSON
94 lines
8.8 KiB
JSON
{
|
|
"@metadata": {
|
|
"authors": [
|
|
"Brad Jorsch",
|
|
"Matthew Flaschen",
|
|
"Matthias Mullie",
|
|
"Moriel Schottlender",
|
|
"Roan Kattouw",
|
|
"Stephane Bisson"
|
|
]
|
|
},
|
|
"apihelp-echocreateevent-description": "Manually trigger a notification to a user",
|
|
"apihelp-echocreateevent-summary": "Manually trigger a notification to a user",
|
|
"apihelp-echocreateevent-example": "Send a notification",
|
|
"apihelp-echocreateevent-param-user": "User to send the notification to",
|
|
"apihelp-echocreateevent-param-header": "Header content of the notification",
|
|
"apihelp-echocreateevent-param-content": "Body content of the notification",
|
|
"apihelp-echocreateevent-param-page": "Page to link to in the notification",
|
|
"apihelp-echocreateevent-param-section": "Section where notification would be delivered",
|
|
"apihelp-echocreateevent-param-email": "Whether to send an email as well",
|
|
"apihelp-echomarkread-summary": "Mark notifications as read for the current user.",
|
|
"apihelp-echomarkread-param-list": "A list of notification IDs to mark as read.",
|
|
"apihelp-echomarkread-param-unreadlist": "A list of notification IDs to mark as unread.",
|
|
"apihelp-echomarkread-param-all": "If set, marks all of a user's notifications as read.",
|
|
"apihelp-echomarkread-param-sections": "A list of sections to mark as read.",
|
|
"apihelp-echomarkread-param-wikis": "List of wikis to mark notification as read (defaults to only current wiki).",
|
|
"apihelp-echomarkread-example-1": "Mark notification 8 as read",
|
|
"apihelp-echomarkread-example-2": "Mark all notifications as read",
|
|
"apihelp-echomarkread-example-3": "Mark notification 1 as unread",
|
|
"apihelp-echomarkseen-summary": "Mark notifications as seen for the current user.",
|
|
"apihelp-echomarkseen-example-1": "Mark notifications of all types as seen",
|
|
"apihelp-echomarkseen-param-type": "Type of notifications to mark as seen: 'alert', 'message' or 'all'.",
|
|
"apihelp-echomarkseen-param-timestampFormat": "Timestamp format to use for output, 'ISO_8601' or 'MW'. 'MW' is deprecated here, so all clients should switch to 'ISO_8601'. This parameter will be removed, and 'ISO_8601' will become the only output format.",
|
|
"apihelp-echomute-summary": "Mute or unmute notifications from certain users or pages.",
|
|
"apihelp-echomute-param-type": "Which mute list to add to or remove from",
|
|
"apihelp-echomute-param-mute": "Pages or users to add to the mute list",
|
|
"apihelp-echomute-param-unmute": "Pages or users to remove from the mute list",
|
|
"apihelp-echopushsubscriptions-summary": "Manage push subscriptions for the current user.",
|
|
"apihelp-echopushsubscriptions-param-command": "Action to perform.",
|
|
"apihelp-echopushsubscriptions+create-summary": "Register push subscriptions for the current user.",
|
|
"apihelp-echopushsubscriptions+create-param-provider": "The push service provider for which to register a token.",
|
|
"apihelp-echopushsubscriptions+create-param-providertoken": "The token to register.",
|
|
"apihelp-echopushsubscriptions+create-param-topic": "The APNS topic (app bundle ID) to send the notification to.",
|
|
"apihelp-echopushsubscriptions+create-example": "Register a push subscription for the current user.",
|
|
"apihelp-echopushsubscriptions+delete-summary": "Unregister push subscriptions for the current user or another specified user.",
|
|
"apihelp-echopushsubscriptions+delete-param-providertoken": "The token associated with the push subscription to unregister.",
|
|
"apihelp-echopushsubscriptions+delete-param-centraluserid": "The central user ID associated with the subscription to unregister.",
|
|
"apihelp-echopushsubscriptions+delete-example": "Unregister a push subscription for the current user.",
|
|
"apihelp-query+notifications-summary": "Get notifications waiting for the current user.",
|
|
"apihelp-query+notifications-param-prop": "Details to request.",
|
|
"apihelp-query+notifications-param-sections": "The notification sections to query (i.e. some combination of 'alert' and 'message').",
|
|
"apihelp-query+notifications-param-groupbysection": "Whether to group the result by section. Each section is fetched separately if set.",
|
|
"apihelp-query+notifications-param-filter": "Filter notifications returned.",
|
|
"apihelp-query+notifications-param-format": "If specified, notifications will be returned formatted this way.",
|
|
"apihelp-query+notifications-paramvalue-format-model": "Raw notification data",
|
|
"apihelp-query+notifications-paramvalue-format-special": "Formatted for Special:Notifications page (and only that!) Do not rely on the HTML as it may change at any given time.",
|
|
"apihelp-query+notifications-paramvalue-format-flyout": "<span class=\"apihelp-deprecated\">Deprecated</span>. Use <kbd>$1format=model</kbd> for raw data",
|
|
"apihelp-query+notifications-paramvalue-format-html": "<span class=\"apihelp-deprecated\">Deprecated</span>. Use <kbd>$1format=model</kbd> for raw data",
|
|
"apihelp-query+notifications-param-limit": "The maximum number of notifications to return.",
|
|
"apihelp-query+notifications-param-wikis": "List of wikis to fetch notifications from (defaults to only current wiki).",
|
|
"apihelp-query+notifications-param-crosswikisummary": "True to opt in to a summary notification of notifications on foreign wikis.",
|
|
"apihelp-query+notifications-param-alertcontinue": "When more alert results are available, use this to continue.",
|
|
"apihelp-query+notifications-param-unreadfirst": "Whether to show unread notifications first (only used if groupbysection is not set).",
|
|
"apihelp-query+notifications-param-alertunreadfirst": "Whether to show unread message notifications first (only used if groupbysection is set).",
|
|
"apihelp-query+notifications-param-messagecontinue": "When more message results are available, use this to continue.",
|
|
"apihelp-query+notifications-param-messageunreadfirst": "Whether to show unread alert notifications first (only used if groupbysection is set).",
|
|
"apihelp-query+notifications-param-titles": "Only return notifications for these pages. To get notifications not associated with any page, use [] as a title.",
|
|
"apihelp-query+notifications-param-bundle": "Whether to show bundle compatible unread notifications according to notification types bundling rules.",
|
|
"apihelp-query+notifications-param-notifiertypes": "Notifier types for which to return notifications.",
|
|
"apihelp-query+notifications-example-1": "List web notifications",
|
|
"apihelp-query+notifications-example-2": "List web notifications, grouped by section, with counts",
|
|
"apihelp-query+notifications-example-3": "List email notifications",
|
|
"apihelp-query+unreadnotificationpages-summary": "Get pages for which there are unread notifications for the current user.",
|
|
"apihelp-query+unreadnotificationpages-param-grouppages": "Group talk pages together with their subject page, and group notifications not associated with a page together with the current user's user page.",
|
|
"apihelp-query+unreadnotificationpages-param-limit": "The maximum number of pages to return.",
|
|
"apihelp-query+unreadnotificationpages-param-wikis": "List of wikis to fetch pages with unread notifications from (defaults to only current wiki).",
|
|
"apihelp-query+unreadnotificationpages-example-1": "List pages with (their amount of) unread notifications",
|
|
"apihelp-echoarticlereminder-summary": "Request a future reminder about the specified article",
|
|
"apihelp-echoarticlereminder-param-pageid": "ID of article to remind the user about",
|
|
"apihelp-echoarticlereminder-param-title": "Title of article to remind the user about",
|
|
"apihelp-echoarticlereminder-param-timestamp": "On which timestamp to remind the user",
|
|
"apihelp-echoarticlereminder-param-comment": "Optional user comment to include in the reminder",
|
|
"apihelp-echoarticlereminder-example-1": "Create an article reminder notification for tomorrow with comment",
|
|
"apihelp-echoarticlereminder-example-2": "Create an article reminder notification for tomorrow without comment",
|
|
"apiwarn-echo-deprecation-timestampformat": "The MW timestamp output format is deprecated here. In the future, ISO 8601 will always be used for the output timestamp format. Adjust your client and set <var>timestampFormat</var> to <kbd>ISO_8601</kbd>.",
|
|
"apiwarn-echo-deprecation-flyout": "<kbd>notformat=flyout</kbd> has been deprecated and will be removed soon. Use <kbd>notformat=model</kbd> to get the raw data or <kbd>notformat=special</kbd> for pre-rendered HTML.",
|
|
"apiwarn-echo-deprecation-html": "<kbd>notformat=html</kbd> has been deprecated and will be removed soon. Use <kbd>notformat=special</kbd> instead.",
|
|
"apierror-echo-event-creation-failed": "Could not create Echo event",
|
|
"apierror-echo-push-token-exists": "The provided token already exists in the database.",
|
|
"apierror-echo-push-token-not-found": "The provided token was not found in the database.",
|
|
"apierror-echo-push-too-many-subscriptions": "The current user has already registered the maximum allowed number of push subscriptions ($1).",
|
|
"apierror-echo-push-topic-required": "The topic field is required for this provider."
|
|
}
|