Configuration

This section is for users who want to restrict what other scripts can request. The other sections are for script developers.

The configuration options for this script allow individuals to restrict what can be requested by other scripts. The options are properties of this script's configuration object which can be created in a user's personal JS with the following lines of code above the other script's import. If importing more than one script that uses this script, place this configuration above the top-most import of those other scripts.

if (!window.andrewds1021) {
    window.andrewds1021 = {
        get_on_site_notifications: {}
    };
} else if (!window.andrewds1021.get_on_site_notifications) {
    window.andrewds1021.get_on_site_notifications = {};
}

To set a particular option, place a line of code between this script's configuration object and the other script's import. It should follow the following format where property is replaced by the option name as listed in the table below and value is replaced by the desired value.

window.andrewds1021.get_on_site_notifications.property = value;

This example sets default_limit to 50 (the maximum allowed value). This will minimize the total number of requests sent to Fandom's notification service.

window.andrewds1021.get_on_site_notifications.default_limit = 50;

Usage

Client scripts submit requests and receive results using mw.hook. To keep things short, this documentation will use shortened names for the hooks. To get the full names, add andrewds1021.get_on_site_notifications. as a prefix. The hook ready is fired by this script once it has completed its set-up and is ready to start receiving requests. As part of the set-up, it performs an initial run using the default request parameter values. The results are returned so any client that does not have specific requirements and does not need to update its list of notifications can attempt to avoid making its own request by listening for the initial results. The initial results will have a counter value of 0 in the returned request information. The script returns results by firing the hook done with the list of notifications as the first argument and the request information as the second argument. Clients can submit requests by firing the hook run with the optional request configuration as the first (and only) argument. In order to avoid overwhelming Fandom's notification service, client requests are processed serially in the order they are received. Similarly, requests to the notification service are sent serially. In short, this script should have no more than one active request with the notification service at any given time.

Request Configuration

Because data passed through hooks can be accessed by other scripts, it is recommended that the client deep freeze the request configuration prior to firing the run hook. The configuration should be an object with any or all of the following properties. Remember that a client's options may be limited by the user as described in the configuration section.

Request Information

Information about the request is returned as the second argument to the done hook. Aside from id, it is a deep frozen object. The returned information provides a means to match the results with a specific request as well as verify certain parameters of the request which may have been limited due to a user's individual configuration.

Notifications

The list of notifications is returned as the first argument to the done hook. It is a deep frozen array of notification objects. A notification object is returned as it was provided by the notification service except when additional details were retrieved due to the use of a mode other than "notification". The script alters the relevant notification object by appending additional users to latestActors and by adding otherEvents. At any level of the notification object structure, properties that are irrelevant or unused might be omitted. The following information regarding the structure is provided as guidance. Fandom may make changes which may or may not be reflected in this documentation.

Used By

If you have developed a script that uses this script, feel free to add your script to this list.

• IgnoreNotifications

Additional Notes

• It seems that using a large limit value for notification requests intermittently causes database errors and failures. As such, the use of a large request limit may result in early termination of notification retrieval.