Skip to content

Getlist Command

Joel edited this page Apr 27, 2018 · 7 revisions

The getlist command can only be used by services that can transfer files (Discord). It will grant the user a .txt document containing the users from the specified lists, with the specified ratings and filters.

This command can only retrieve taglists that the Tracker has permissions to. However, the actual .txt file will be publicly visible to anyone that can access the same channel. As such, it is recommended to only execute this command in a DM with the bot account.

Arguments

  • Tag command arguments
    (please see Tag Command for more extensive information on this).
    • Taglist(s)
      specify one or more taglists.
    • Ratings (Optional)
      If no ratings are supplied, any taglists that require them are ignored.
    • Filters (Optional)
      By default no filters are applied. Multiple allowed.
  • Document syntax (Optional)
    It is possible to indicate how the document should be laid out to the user. By default the getlist command will retrieve all users in alphabetical order separated by line breaks. If a custom syntax needs to be used, this must be between "" quotation marks. The following options exist in syntax:
    • %n: The Imgur name
    • %i: The Imgur id
    • %c: Counter (0-based)
    • \n: A line-break
    • \t: A tab

Syntax example

We use:
@Prefix: is assumed to be the command prefix
abc: the taglist
s, q, e: the ratings
weather: the filter

  • @Prefix getlist abc
    Retrieve a .txt document containing all users from taglist abc in alphabetical order, separated by line-breaks.
  • @Prefix getlist abc "%n|"
    Retrieve a .txt document containing all users from taglist abc in alphabetical order. All users are posted on the same line and separated by a | character.
  • @Prefix getlist abc s "%i,%n,\n"
    Retrieve a .csv-styled document containing 2 columns, the first with the imgur id and the second with the imgur name. The list is restricted to users that were part of the safe taglist.
  • @Prefix getlist abc weather "%c: %n\n"
    Retrieve a line-break separated list where the ordered names are preceded by a number, counting up from 0. Will exclude any users that have the weather filter.

Clone this wiki locally