Class APIMe

Index

Constructors

Methods

clearCurrentUserNotifications connectPlatform deleteServerPremium getConnectPlatformUrl getCurrentUser getCurrentUserGuilds getGuildDiscordData getServerPremium setServerPremium unlinkPlatform

Constructors

constructor

new APIMe(web): APIMe
Parameters
- web: WebDataManager
Returns APIMe
- Defined in src/classes/@me.ts:8

Methods

clearCurrentUserNotifications

clearCurrentUserNotifications(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/@me.ts:18

connectPlatform

connectPlatform(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
      auth: string;
      code: string;
      platform:
          | "kick"
          | "twitch"
          | "rumble"
          | "youtube"
          | "club";
      state?: string;
  }
  - auth: string
  - code: string
  - platform:
        | "kick"
        | "twitch"
        | "rumble"
        | "youtube"
        | "club"
  - Optionalstate?: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/@me.ts:49

deleteServerPremium

deleteServerPremium(__namedParameters): Promise<WebResponse<ServerPremiumRemoval>>
Take the upgrade back off whichever server holds it. Starts the cooldown, same as placing it.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<ServerPremiumRemoval>>
- Defined in src/classes/@me.ts:86

getConnectPlatformUrl

getConnectPlatformUrl(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  platform: "kick" | "twitch";
  }
  - platform: "kick" | "twitch"
Returns Promise<WebResponse<string>>
- Defined in src/classes/@me.ts:42

getCurrentUser

getCurrentUser(__namedParameters): Promise<WebResponse<CurrentUser>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<CurrentUser>>
- Defined in src/classes/@me.ts:11

getCurrentUserGuilds

getCurrentUserGuilds(__namedParameters): Promise<WebResponse<CurrentUserGuilds>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<CurrentUserGuilds>>
- Defined in src/classes/@me.ts:25

getGuildDiscordData

getGuildDiscordData<T>(__namedParameters): Promise<WebResponse<DiscordGuildData<T>>>
Type Parameters
- T extends GuildDataType
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      refresh?: boolean;
      types: never[];
  }
  - auth: string
  - guildId: string
  - Optionalrefresh?: boolean
  - types: never[]
Returns Promise<WebResponse<DiscordGuildData<T>>>
- Defined in src/classes/@me.ts:32

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>>
- Defined in src/classes/@me.ts:70

setServerPremium

setServerPremium(__namedParameters): Promise<WebResponse<ServerPremiumAssignment>>
Place the upgrade on a server. Refuses with 409 when it is already placed, or still on cooldown.
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<ServerPremiumAssignment>>
- Defined in src/classes/@me.ts:78

unlinkPlatform

unlinkPlatform(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
      auth: string;
      platform:
          | "kick"
          | "twitch"
          | "rumble"
          | "youtube"
          | "club";
  }
  - auth: string
  - platform:
        | "kick"
        | "twitch"
        | "rumble"
        | "youtube"
        | "club"
Returns Promise<WebResponse<string>>
- Defined in src/classes/@me.ts:58

Class APIMe

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIMe

Methods

clearCurrentUserNotifications

Parameters

auth: string

Returns Promise<WebResponse<string>>

connectPlatform

Parameters

auth: string

code: string

platform: | "kick" | "twitch" | "rumble" | "youtube" | "club"

Optionalstate?: string

Returns Promise<WebResponse<string>>

deleteServerPremium

Parameters

auth: string

Returns Promise<WebResponse<ServerPremiumRemoval>>

getConnectPlatformUrl

Parameters

platform: "kick" | "twitch"

Returns Promise<WebResponse<string>>

getCurrentUser

Parameters

auth: string

Returns Promise<WebResponse<CurrentUser>>

getCurrentUserGuilds

Parameters

auth: string

Returns Promise<WebResponse<CurrentUserGuilds>>

getGuildDiscordData

Type Parameters

Parameters

auth: string

guildId: string

Optionalrefresh?: boolean

types: never[]

Returns Promise<WebResponse<DiscordGuildData<T>>>

getServerPremium

Parameters

auth: string

Returns Promise<WebResponse<ServerPremiumState>>

setServerPremium

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<ServerPremiumAssignment>>

unlinkPlatform

Parameters

auth: string

platform: | "kick" | "twitch" | "rumble" | "youtube" | "club"

Returns Promise<WebResponse<string>>

Settings

On This Page

platform:
| "kick"
| "twitch"
| "rumble"
| "youtube"
| "club"

`Optional`state?: string

`Optional`refresh?: boolean

platform:
| "kick"
| "twitch"
| "rumble"
| "youtube"
| "club"