Class APIGuildClipForward

Constructors

constructor

Methods

createClipForward deleteClipForward getGuildClipForward getGuildClipForwards testClipForward updateClipForward

Constructors

constructor

Methods

createClipForward

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

  • Parameters

    • __namedParameters: {
          auth: string;
          body: {
              allowMature?: null | boolean;
              blacklistCategories?: string[];
              blacklistClippers?: string[];
              channelId?: null | string;
              clipForwardId: string;
              customMessages?: {
                  buttons: {
                      emojiUnicodeOrId: null | string;
                      title: string;
                      url: null | string;
                  }[];
                  content: null | string;
                  embed: null | {
                      author: null | string;
                      authorIcon: null | string;
                      color: null | string;
                      description: null | string;
                      fields: {
                          inline: null | boolean;
                          name: string;
                          value: null | string;
                      }[];
                      footer: null | string;
                      footerIcon: null | string;
                      image: null | string;
                      thumbnail: null | string;
                      title: null | string;
                      url: null | string;
                  };
                  showInviteButton: null | boolean;
                  showWatchButton: null | boolean;
                  type:
                      | "clip"
                      | "clipForward"
                      | "vod"
                      | "kickLive"
                      | "kickOffline"
                      | "twitchLive"
                      | "twitchOffline"
                      | "rumbleLive"
                      | "rumbleOffline"
                      | "rumbleVideo"
                      | "tiktokLive"
                      | "tiktokOffline"
                      | "tiktokVideo"
                      | "youtubeLive"
                      | "youtubeVideo"
                      | "whatnotLive"
                      | "whatnotOffline"
                      | "clubPost"
                      | "twitterPost"
                      | "twitterLive"
                      | "twitterOffline";
                  webhook: null | {
                      avatarUrl: null | string;
                      enabled: null | boolean;
                      username: null | string;
                  };
              }[];
              guildId: string;
              includeOffline?: null | boolean;
              lastClipAt?: null | Date;
              lastClipId?: null | string;
              maxPerCycle?: null | number;
              minDuration?: null | number;
              minViews?: null | number;
              pingRoleId?: null | string;
              platform: "kick" | "twitch";
              showNotifyButton?: null | boolean;
              streamerUserName: string;
              usePerStreamerEmbeds?: null | boolean;
              whitelistCategories?: string[];
              whitelistClippers?: string[];
          };
          guildId: string;
      }
      • auth: string
      • body: {
            allowMature?: null | boolean;
            blacklistCategories?: string[];
            blacklistClippers?: string[];
            channelId?: null | string;
            clipForwardId: string;
            customMessages?: {
                buttons: {
                    emojiUnicodeOrId: null | string;
                    title: string;
                    url: null | string;
                }[];
                content: null | string;
                embed: null | {
                    author: null | string;
                    authorIcon: null | string;
                    color: null | string;
                    description: null | string;
                    fields: {
                        inline: null | boolean;
                        name: string;
                        value: null | string;
                    }[];
                    footer: null | string;
                    footerIcon: null | string;
                    image: null | string;
                    thumbnail: null | string;
                    title: null | string;
                    url: null | string;
                };
                showInviteButton: null | boolean;
                showWatchButton: null | boolean;
                type:
                    | "clip"
                    | "clipForward"
                    | "vod"
                    | "kickLive"
                    | "kickOffline"
                    | "twitchLive"
                    | "twitchOffline"
                    | "rumbleLive"
                    | "rumbleOffline"
                    | "rumbleVideo"
                    | "tiktokLive"
                    | "tiktokOffline"
                    | "tiktokVideo"
                    | "youtubeLive"
                    | "youtubeVideo"
                    | "whatnotLive"
                    | "whatnotOffline"
                    | "clubPost"
                    | "twitterPost"
                    | "twitterLive"
                    | "twitterOffline";
                webhook: null | {
                    avatarUrl: null | string;
                    enabled: null | boolean;
                    username: null | string;
                };
            }[];
            guildId: string;
            includeOffline?: null | boolean;
            lastClipAt?: null | Date;
            lastClipId?: null | string;
            maxPerCycle?: null | number;
            minDuration?: null | number;
            minViews?: null | number;
            pingRoleId?: null | string;
            platform: "kick" | "twitch";
            showNotifyButton?: null | boolean;
            streamerUserName: string;
            usePerStreamerEmbeds?: null | boolean;
            whitelistCategories?: string[];
            whitelistClippers?: string[];
        }
        • OptionalallowMature?: null | boolean
        • OptionalblacklistCategories?: string[]
        • OptionalblacklistClippers?: string[]
        • OptionalchannelId?: null | string
        • clipForwardId: string
        • OptionalcustomMessages?: {
              buttons: {
                  emojiUnicodeOrId: null | string;
                  title: string;
                  url: null | string;
              }[];
              content: null | string;
              embed: null | {
                  author: null | string;
                  authorIcon: null | string;
                  color: null | string;
                  description: null | string;
                  fields: {
                      inline: null | boolean;
                      name: string;
                      value: null | string;
                  }[];
                  footer: null | string;
                  footerIcon: null | string;
                  image: null | string;
                  thumbnail: null | string;
                  title: null | string;
                  url: null | string;
              };
              showInviteButton: null | boolean;
              showWatchButton: null | boolean;
              type:
                  | "clip"
                  | "clipForward"
                  | "vod"
                  | "kickLive"
                  | "kickOffline"
                  | "twitchLive"
                  | "twitchOffline"
                  | "rumbleLive"
                  | "rumbleOffline"
                  | "rumbleVideo"
                  | "tiktokLive"
                  | "tiktokOffline"
                  | "tiktokVideo"
                  | "youtubeLive"
                  | "youtubeVideo"
                  | "whatnotLive"
                  | "whatnotOffline"
                  | "clubPost"
                  | "twitterPost"
                  | "twitterLive"
                  | "twitterOffline";
              webhook: null | {
                  avatarUrl: null | string;
                  enabled: null | boolean;
                  username: null | string;
              };
          }[]
        • guildId: string
        • OptionalincludeOffline?: null | boolean
        • OptionallastClipAt?: null | Date
        • OptionallastClipId?: null | string
        • OptionalmaxPerCycle?: null | number
        • OptionalminDuration?: null | number
        • OptionalminViews?: null | number
        • OptionalpingRoleId?: null | string
        • platform: "kick" | "twitch"
        • OptionalshowNotifyButton?: null | boolean
        • streamerUserName: string
        • OptionalusePerStreamerEmbeds?: null | boolean
        • OptionalwhitelistCategories?: string[]
        • OptionalwhitelistClippers?: string[]
      • guildId: string

    Returns Promise<WebResponse<string>>

deleteClipForward

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

  • Parameters

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

    Returns Promise<WebResponse<string>>

getGuildClipForward

  • getGuildClipForward(__namedParameters): Promise<WebResponse<{
        customMessages: ({
            buttons: ({
                cfCustomMessage: (...) | (...);
            } & {
                cfCustomMessageId: string;
                dbId: string;
                emojiUnicodeOrId: (...) | (...);
                title: string;
                url: (...) | (...);
            })[];
            clipForward: null | {
                allowMature: null | boolean;
                blacklistCategories: string[];
                blacklistClippers: string[];
                channelId: null | string;
                clipForwardId: string;
                dbId: string;
                guildId: string;
                includeOffline: null | boolean;
                lastClipAt: null | Date;
                lastClipId: null | string;
                maxPerCycle: null | number;
                minDuration: null | number;
                minViews: null | number;
                pingRoleId: null | string;
                platform: PlatformEnum;
                showNotifyButton: null | boolean;
                streamerUserName: string;
                usePerStreamerEmbeds: null | boolean;
                whitelistCategories: string[];
                whitelistClippers: string[];
            };
            embed: null | {
                cfCustomMessage: (...) | (...);
                fields: (...)[];
            } & {
                author: (...) | (...);
                authorIcon: (...) | (...);
                cfCustomMessageId: string;
                color: (...) | (...);
                dbId: string;
                description: (...) | (...);
                footer: (...) | (...);
                footerIcon: (...) | (...);
                image: (...) | (...);
                thumbnail: (...) | (...);
                title: (...) | (...);
                url: (...) | (...);
            };
            webhook: null | {
                cfCustomMessage: (...) | (...);
            } & {
                avatarUrl: (...) | (...);
                cfCustomMessageId: string;
                dbId: string;
                enabled: (...) | (...) | (...);
                username: (...) | (...);
            };
        } & {
            clipForwardId: string;
            content: null | string;
            dbId: string;
            showInviteButton: null | boolean;
            showWatchButton: null | boolean;
            type: StreamerMessageTypeEnum;
        })[];
    } & {
        allowMature: null | boolean;
        blacklistCategories: string[];
        blacklistClippers: string[];
        channelId: null | string;
        clipForwardId: string;
        dbId: string;
        guildId: string;
        includeOffline: null | boolean;
        lastClipAt: null | Date;
        lastClipId: null | string;
        maxPerCycle: null | number;
        minDuration: null | number;
        minViews: null | number;
        pingRoleId: null | string;
        platform: PlatformEnum;
        showNotifyButton: null | boolean;
        streamerUserName: string;
        usePerStreamerEmbeds: null | boolean;
        whitelistCategories: string[];
        whitelistClippers: string[];
    }>>

  • Parameters

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

    Returns Promise<WebResponse<{
        customMessages: ({
            buttons: ({
                cfCustomMessage: (...) | (...);
            } & {
                cfCustomMessageId: string;
                dbId: string;
                emojiUnicodeOrId: (...) | (...);
                title: string;
                url: (...) | (...);
            })[];
            clipForward: null | {
                allowMature: null | boolean;
                blacklistCategories: string[];
                blacklistClippers: string[];
                channelId: null | string;
                clipForwardId: string;
                dbId: string;
                guildId: string;
                includeOffline: null | boolean;
                lastClipAt: null | Date;
                lastClipId: null | string;
                maxPerCycle: null | number;
                minDuration: null | number;
                minViews: null | number;
                pingRoleId: null | string;
                platform: PlatformEnum;
                showNotifyButton: null | boolean;
                streamerUserName: string;
                usePerStreamerEmbeds: null | boolean;
                whitelistCategories: string[];
                whitelistClippers: string[];
            };
            embed: null | {
                cfCustomMessage: (...) | (...);
                fields: (...)[];
            } & {
                author: (...) | (...);
                authorIcon: (...) | (...);
                cfCustomMessageId: string;
                color: (...) | (...);
                dbId: string;
                description: (...) | (...);
                footer: (...) | (...);
                footerIcon: (...) | (...);
                image: (...) | (...);
                thumbnail: (...) | (...);
                title: (...) | (...);
                url: (...) | (...);
            };
            webhook: null | {
                cfCustomMessage: (...) | (...);
            } & {
                avatarUrl: (...) | (...);
                cfCustomMessageId: string;
                dbId: string;
                enabled: (...) | (...) | (...);
                username: (...) | (...);
            };
        } & {
            clipForwardId: string;
            content: null | string;
            dbId: string;
            showInviteButton: null | boolean;
            showWatchButton: null | boolean;
            type: StreamerMessageTypeEnum;
        })[];
    } & {
        allowMature: null | boolean;
        blacklistCategories: string[];
        blacklistClippers: string[];
        channelId: null | string;
        clipForwardId: string;
        dbId: string;
        guildId: string;
        includeOffline: null | boolean;
        lastClipAt: null | Date;
        lastClipId: null | string;
        maxPerCycle: null | number;
        minDuration: null | number;
        minViews: null | number;
        pingRoleId: null | string;
        platform: PlatformEnum;
        showNotifyButton: null | boolean;
        streamerUserName: string;
        usePerStreamerEmbeds: null | boolean;
        whitelistCategories: string[];
        whitelistClippers: string[];
    }>>

getGuildClipForwards

  • getGuildClipForwards(__namedParameters): Promise<WebResponse<GuildClipForwardsData>>

  • Every clip-forward rule for this guild, with the per-platform allowance.

    BREAKING in 1.9.40: this returned GuildClipForward[] directly. The rows moved to data.forwards so the allowance could travel with them - WebResponse is exactly { status, data }, so there is no room for a sibling field and an array has nowhere to put one.

    The caps were always enforced on create; they were simply never reported, which made a capped feature indistinguishable from an uncapped one until the create failed.

    Parameters

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

    Returns Promise<WebResponse<GuildClipForwardsData>>

testClipForward

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

  • Parameters

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

    Returns Promise<WebResponse<string>>

updateClipForward

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

  • Parameters

    • __namedParameters: {
          auth: string;
          body: {
              allowMature?: null | boolean;
              blacklistCategories?: string[];
              blacklistClippers?: string[];
              channelId?: null | string;
              clipForwardId?: string;
              customMessages?: {
                  buttons?: {
                      emojiUnicodeOrId?: null | string;
                      title?: string;
                      url?: null | string;
                  }[];
                  content?: null | string;
                  embed?: null | {
                      author?: null | string;
                      authorIcon?: null | string;
                      color?: null | string;
                      description?: null | string;
                      fields?: {
                          inline?:
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          name?: (...) | (...);
                          value?: (...) | (...) | (...);
                      }[];
                      footer?: null | string;
                      footerIcon?: null | string;
                      image?: null | string;
                      thumbnail?: null | string;
                      title?: null | string;
                      url?: null | string;
                  };
                  showInviteButton?: null | boolean;
                  showWatchButton?: null | boolean;
                  type?:
                      | "clip"
                      | "clipForward"
                      | "vod"
                      | "kickLive"
                      | "kickOffline"
                      | "twitchLive"
                      | "twitchOffline"
                      | "rumbleLive"
                      | "rumbleOffline"
                      | "rumbleVideo"
                      | "tiktokLive"
                      | "tiktokOffline"
                      | "tiktokVideo"
                      | "youtubeLive"
                      | "youtubeVideo"
                      | "whatnotLive"
                      | "whatnotOffline"
                      | "clubPost"
                      | "twitterPost"
                      | "twitterLive"
                      | "twitterOffline";
                  webhook?: null | {
                      avatarUrl?: null | string;
                      enabled?: null | boolean;
                      username?: null | string;
                  };
              }[];
              guildId?: string;
              includeOffline?: null | boolean;
              lastClipAt?: null | Date;
              lastClipId?: null | string;
              maxPerCycle?: null | number;
              minDuration?: null | number;
              minViews?: null | number;
              pingRoleId?: null | string;
              platform?: "kick" | "twitch";
              showNotifyButton?: null | boolean;
              streamerUserName?: string;
              usePerStreamerEmbeds?: null | boolean;
              whitelistCategories?: string[];
              whitelistClippers?: string[];
          };
          clipForwardId: string;
          guildId: string;
      }
      • auth: string
      • body: {
            allowMature?: null | boolean;
            blacklistCategories?: string[];
            blacklistClippers?: string[];
            channelId?: null | string;
            clipForwardId?: string;
            customMessages?: {
                buttons?: {
                    emojiUnicodeOrId?: null | string;
                    title?: string;
                    url?: null | string;
                }[];
                content?: null | string;
                embed?: null | {
                    author?: null | string;
                    authorIcon?: null | string;
                    color?: null | string;
                    description?: null | string;
                    fields?: {
                        inline?:
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        name?: (...) | (...);
                        value?: (...) | (...) | (...);
                    }[];
                    footer?: null | string;
                    footerIcon?: null | string;
                    image?: null | string;
                    thumbnail?: null | string;
                    title?: null | string;
                    url?: null | string;
                };
                showInviteButton?: null | boolean;
                showWatchButton?: null | boolean;
                type?:
                    | "clip"
                    | "clipForward"
                    | "vod"
                    | "kickLive"
                    | "kickOffline"
                    | "twitchLive"
                    | "twitchOffline"
                    | "rumbleLive"
                    | "rumbleOffline"
                    | "rumbleVideo"
                    | "tiktokLive"
                    | "tiktokOffline"
                    | "tiktokVideo"
                    | "youtubeLive"
                    | "youtubeVideo"
                    | "whatnotLive"
                    | "whatnotOffline"
                    | "clubPost"
                    | "twitterPost"
                    | "twitterLive"
                    | "twitterOffline";
                webhook?: null | {
                    avatarUrl?: null | string;
                    enabled?: null | boolean;
                    username?: null | string;
                };
            }[];
            guildId?: string;
            includeOffline?: null | boolean;
            lastClipAt?: null | Date;
            lastClipId?: null | string;
            maxPerCycle?: null | number;
            minDuration?: null | number;
            minViews?: null | number;
            pingRoleId?: null | string;
            platform?: "kick" | "twitch";
            showNotifyButton?: null | boolean;
            streamerUserName?: string;
            usePerStreamerEmbeds?: null | boolean;
            whitelistCategories?: string[];
            whitelistClippers?: string[];
        }
        • OptionalallowMature?: null | boolean
        • OptionalblacklistCategories?: string[]
        • OptionalblacklistClippers?: string[]
        • OptionalchannelId?: null | string
        • OptionalclipForwardId?: string
        • OptionalcustomMessages?: {
              buttons?: {
                  emojiUnicodeOrId?: null | string;
                  title?: string;
                  url?: null | string;
              }[];
              content?: null | string;
              embed?: null | {
                  author?: null | string;
                  authorIcon?: null | string;
                  color?: null | string;
                  description?: null | string;
                  fields?: {
                      inline?:
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      name?: (...) | (...);
                      value?: (...) | (...) | (...);
                  }[];
                  footer?: null | string;
                  footerIcon?: null | string;
                  image?: null | string;
                  thumbnail?: null | string;
                  title?: null | string;
                  url?: null | string;
              };
              showInviteButton?: null | boolean;
              showWatchButton?: null | boolean;
              type?:
                  | "clip"
                  | "clipForward"
                  | "vod"
                  | "kickLive"
                  | "kickOffline"
                  | "twitchLive"
                  | "twitchOffline"
                  | "rumbleLive"
                  | "rumbleOffline"
                  | "rumbleVideo"
                  | "tiktokLive"
                  | "tiktokOffline"
                  | "tiktokVideo"
                  | "youtubeLive"
                  | "youtubeVideo"
                  | "whatnotLive"
                  | "whatnotOffline"
                  | "clubPost"
                  | "twitterPost"
                  | "twitterLive"
                  | "twitterOffline";
              webhook?: null | {
                  avatarUrl?: null | string;
                  enabled?: null | boolean;
                  username?: null | string;
              };
          }[]
        • OptionalguildId?: string
        • OptionalincludeOffline?: null | boolean
        • OptionallastClipAt?: null | Date
        • OptionallastClipId?: null | string
        • OptionalmaxPerCycle?: null | number
        • OptionalminDuration?: null | number
        • OptionalminViews?: null | number
        • OptionalpingRoleId?: null | string
        • Optionalplatform?: "kick" | "twitch"
        • OptionalshowNotifyButton?: null | boolean
        • OptionalstreamerUserName?: string
        • OptionalusePerStreamerEmbeds?: null | boolean
        • OptionalwhitelistCategories?: string[]
        • OptionalwhitelistClippers?: string[]
      • clipForwardId: string
      • guildId: string

    Returns Promise<WebResponse<string>>

Settings

Member Visibility

On This Page

Constructors
Methods