Skip to content

Subscription Command

Joel edited this page Apr 8, 2018 · 17 revisions

The sub command will subscribe the specified user to the indicated taglists. Any Tracker can only subscribe a user to the taglists that it has permissions for, any other lists will be ignored. Subscriptions can only be done for one user at a time. If a larger volume of users should be subscribed, please take a look at

When changing the subscription data for a user, it is not necessary to unsubscribe them first. Issuing a sub command will overwrite the subscription data for the specified taglists. It will keep the original subscriptions for any taglists that weren't mentioned intact.

Arguments

  • User name
    The very first argument to a subscription request should always be the full (case-insensitive) username.
  • Taglist subscription (At least one)
    There should be one or more taglist-subscriptions supplied for the user. For each taglist, if the user was already subscribed it will override said subscription. All subscriptions follow the following format:
    • Taglist abbreviation
      Any subscription should always start with the taglist that the user will be subscribed to. Any arguments before the first taglist abbreviation will be ignored by the system.

    • Ratings (Optional)
      If the specified taglist uses ratings, they should be supplied here. The following ratings are available:

      • s: safe
      • q: questionable
      • e: explicit

      The user should be subscribed to all ratings that it wants to receive. If no ratings were supplied and the taglist does use ratings, the subscription will default to s q e (all 3 ratings).

    • Filters (Optional)
      Any filters (that do not overlap with a taglist or a rating) can be used. Keep in mind that filters are only applied to each individual taglist subscription. Separate multiple filters with a space in between.

Syntax example

We use:
@Prefix: is assumed to be the command prefix
new_user: the account-name of the new user.
abc, def: taglists
cold, hot: filter

  • @Prefix sub new_user abc
    (YES) Subscribes user new_user to the taglist abc. If abc uses ratings, this subscription will default to using s q e (all 3 ratings).

  • @Prefix sub abc
    (NO) Does not indicate the user that should be subscribed.

  • @Prefix sub new_user ignored_arguments abc
    (YES) Subscribes the user, but completely ignores ignored_arguments until it finds a taglist.

  • @Prefix sub new_user abc s q
    (YES) Subscribes the user to the abc taglist while filtering explicit content.

  • @Prefix sub new_user abc s hot
    @Prefix sub new_user abc hot s
    (YES) Subscribes the user to the abc taglist with a safe rating and using the filter hot

  • @Prefix sub new_user abc s hot def e cold
    (YES) Subscribes the user to:

    • The abc taglist with rating s and filter hot
    • The def taglist with rating e and filter cold

Clone this wiki locally