Options
All
  • Public
  • Public/Protected
  • All
Menu

Module banned

Ban API

Provides various utilities for universally banning/unbanning users across any number of bot instances

Note: because this API relies on the data store initialized in the login module, none of its functions will work unless you've logged in already via a call to login.login.

Index

Functions

Const addUser

  • Adds the user represented by the provided user ID to the list of banned users

    Parameters

    Returns void

Const getUsers

  • Provides a list of user IDs representing users who are currently banned.

    Parameters

    Returns void

Const isMessage

  • Utility function to quickly check whether to accept a message based on whether its sender is banned

    Parameters

    Returns void

Const isUser

Const removeUser

  • Removes the user represented by the provided user ID to the list of banned users

    Parameters

    Returns void

Generated using TypeDoc