Class APIGuildPlatform

Constructors

constructor

Methods

createGuildStreamer deleteGuildStreamer getGuildStreamer getGuildStreamers sendTestNotification updateGuildStreamer updateGuildStreamerOrder

Constructors

constructor

Methods

createGuildStreamer

deleteGuildStreamer

getGuildStreamer

getGuildStreamers

sendTestNotification

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

  • Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
          platform: never;
          rumbleType?: RumbleType;
          streamer: string;
          subType?: SubType;
      }
      • auth: string
      • guildId: string
      • platform: never
      • OptionalrumbleType?: RumbleType
      • streamer: string
      • OptionalsubType?: SubType

    Returns Promise<WebResponse<string>>

updateGuildStreamer

updateGuildStreamerOrder

  • updateGuildStreamerOrder<P>(__namedParameters): Promise<WebResponse<{
        streamers: GuildStreamerOrderEntry[];
    }>>

  • Save the dashboard's drag order (API capability creatorOrder on /premium/plans; an older API has no route). streamers is the FULL order top to bottom, by streamerUserName. Names not sent keep their relative order after the sent ones; unknown names are ignored. Cheap and safe to call after every drag (debounce ~1s).

    The order decides which creators stay on when the server is over its plan's creator limit: the first N post, the rest come back limitLocked: true (kept with their settings, silent) until the server is under its limit again or they are dragged above an active one.

    Type Parameters

    Parameters

    • __namedParameters: {
          auth: string;
          guildId: string;
          platform: P;
          streamers: string[];
      }
      • auth: string
      • guildId: string
      • platform: P
      • streamers: string[]

    Returns Promise<WebResponse<{
        streamers: GuildStreamerOrderEntry[];
    }>>

Settings

Member Visibility

On This Page

Constructors
Methods