Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SuspendedService

Suspended services.

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly dbm

dbm: default

Methods

deleteSuspension

  • deleteSuspension(suspensionID: string): Promise<void>

  • Delete a suspension record.

    Parameters

    • suspensionID: string

      A suspension record's ID.

    Returns Promise<void>

getSuspension

  • getSuspension(suspensionID: string): Promise<Suspended>

  • Get a suspension record.

    Parameters

    • suspensionID: string

      A suspension record's ID.

    Returns Promise<Suspended>

    The suspension record.

suspendUser

  • suspendUser(userID: string, until: number, prune?: boolean): Promise<string>

  • Suspend a user's account.

    Parameters

    • userID: string

      A user's ID.

    • until: number

      The time at which the account will no longer be suspended.

    • prune: boolean = true

      Whether or not to prune the suspension when the time comes.

    Returns Promise<string>

    The new suspension record's ID.

suspendedUsers

  • Get all suspended users.

    Returns Promise<SuspendedUser[]>

    All suspended users

suspensionExists

  • suspensionExists(suspensionID: string): Promise<boolean>

  • Check if a suspension record exists.

    Parameters

    • suspensionID: string

      A suspension record's ID.

    Returns Promise<boolean>

    Whether or not the suuspension record exists.

userIsSuspended

  • userIsSuspended(userID: string): Promise<boolean>

  • Check whether or not a user's account has been suspended.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the user's account has been suspended.

Generated using TypeDoc