Class APIMe

Constructors

constructor

Methods

clearCurrentUserNotifications confirmMinecraftAuthorization connectMinecraft connectPlatform createMinecraftAuthorization deleteServerPremium getConnectPlatformUrl getCurrentUser getCurrentUserGuilds getGuildDiscordData getMinecraftLinks getServerPremium setServerPremium unlinkMinecraft unlinkPlatform

Constructors

constructor

Methods

clearCurrentUserNotifications

confirmMinecraftAuthorization

  • confirmMinecraftAuthorization(__namedParameters): Promise<WebResponse<MinecraftLinkResult>>

  • In-game P13, step 2: "Link to @you" on the confirm screen. Links, and adds the player to the Discord server(s) whose owner or Noti staff turned that on. Single-use: 400 "This confirm page has expired" after 5 minutes or a second click. 403 / 409 with the same ready-to-show messages as connectMinecraft (locked, cooldown, taken).

    Parameters

    • __namedParameters: {
          pendingId: string;
      }
      • pendingId: string

    Returns Promise<WebResponse<MinecraftLinkResult>>

connectMinecraft

  • connectMinecraft(__namedParameters): Promise<WebResponse<MinecraftLinkResult>>

  • Link a Minecraft account: the code /noti link printed in a connected Minecraft server. The link counts only in that server's Discord server. 400 for a wrong or expired code (it is spent either way), 409 when that Minecraft account is already linked to someone else there. Linking again in the same server replaces the old one.

    Parameters

    • __namedParameters: {
          auth: string;
          code: string;
      }
      • auth: string
      • code: string

    Returns Promise<WebResponse<MinecraftLinkResult>>

connectPlatform

  • connectPlatform(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          code: string;
          platform:
              | "kick"
              | "twitch"
              | "rumble"
              | "youtube"
              | "whatnot"
              | "club"
              | "twitter";
          state?: string;
      }
      • auth: string
      • code: string
      • platform:
            | "kick"
            | "twitch"
            | "rumble"
            | "youtube"
            | "whatnot"
            | "club"
            | "twitter"
      • Optionalstate?: string

    Returns Promise<WebResponse<string>>

createMinecraftAuthorization

  • createMinecraftAuthorization(__namedParameters): Promise<WebResponse<MinecraftAuthorization>>

  • In-game P13, step 1: Discord's Authorize screen sent the player to noti.bot with code and state in the URL. Pass both as they arrived. NO auth: authorizing with Discord is the sign-in, for this link only. Answers what the confirm screen shows - whose Minecraft account, which Discord server, and who is authorizing. Nothing is linked yet. 400 with a ready-to-show message (expired link, Discord refused); 403 when the feature is not available.

    Parameters

    • __namedParameters: {
          code: string;
          state: string;
      }
      • code: string
      • state: string

    Returns Promise<WebResponse<MinecraftAuthorization>>

deleteServerPremium

getConnectPlatformUrl

  • getConnectPlatformUrl(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          platform: "kick" | "twitch";
      }
      • platform: "kick" | "twitch"

    Returns Promise<WebResponse<string>>

getCurrentUser

getCurrentUserGuilds

getGuildDiscordData

getMinecraftLinks

getServerPremium

  • getServerPremium(__namedParameters): Promise<WebResponse<ServerPremiumState>>

  • The one server upgrade that comes with User Premium: where it currently sits, and whether it can be moved yet. Everything the dashboard needs is inside data - a field beside it would exist at runtime and be invisible to these types.

    Parameters

    • __namedParameters: {
          auth: string;
      }
      • auth: string

    Returns Promise<WebResponse<ServerPremiumState>>

setServerPremium

unlinkMinecraft

  • unlinkMinecraft(__namedParameters): Promise<WebResponse<string>>

  • Unlink in one server. 404 when nothing is linked there.

    Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
      }
      • auth: string
      • guildId: string

    Returns Promise<WebResponse<string>>

unlinkPlatform

  • unlinkPlatform(__namedParameters): Promise<WebResponse<string>>

  • Parameters

    • __namedParameters: {
          auth: string;
          platform:
              | "kick"
              | "twitch"
              | "rumble"
              | "youtube"
              | "whatnot"
              | "club"
              | "twitter";
      }
      • auth: string
      • platform:
            | "kick"
            | "twitch"
            | "rumble"
            | "youtube"
            | "whatnot"
            | "club"
            | "twitter"

    Returns Promise<WebResponse<string>>

Settings

Member Visibility

On This Page

Constructors
Methods