Class CategoryChannel

Hierarchy

• ObjectToLower<
      Omit<APIGuildCategoryChannel, "permission_overwrites" | "guild_id">,
  >
• {
      api: APIRoutes;
      cache: Cache;
      client: UsingClient;
      createdAt: Date;
      createdTimestamp: number;
      flags?: ChannelFlags;
      guildId: string;
      id: string;
      invites: {
          create: (
              data: Omit<CreateInviteFromChannel, "channelId">,
          ) => Promise<
              {
                  approximateMemberCount?: number;
                  approximatePresenceCount?: number;
                  channel: null
                  | { id: string; name: null | string; type: ChannelType };
                  code: string;
                  createdAt: string;
                  expiresAt?: null | string;
                  guild?: {
                      banner: null | string;
                      description: null | string;
                      features: GuildFeature[];
                      icon: null | string;
                      id: string;
                      name: string;
                      nsfwLevel: GuildNSFWLevel;
                      premiumSubscriptionCount?: number;
                      splash: null | string;
                      vanityUrlCode: null | string;
                      verificationLevel: GuildVerificationLevel;
                  };
                  guildScheduledEvent?: | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: StageInstance;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: Voice;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: null;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: { location: string };
                      entityType: External;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  };
                  inviter?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  maxAge: number;
                  maxUses: number;
                  targetApplication?: {
                      approximateGuildCount?: number;
                      approximateUserInstallCount?: number;
                      bot?: APIUser;
                      botPublic?: boolean;
                      botRequireCodeGrant?: boolean;
                      coverImage?: string;
                      customInstallUrl?: string;
                      description?: string;
                      flags?: ApplicationFlags;
                      guild?: APIPartialGuild;
                      guildId?: string;
                      icon?: null
                      | string;
                      id?: string;
                      installParams?: APIApplicationInstallParams;
                      integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
                      interactionsEndpointUrl?: null | string;
                      name?: string;
                      owner?: APIUser;
                      primarySkuId?: string;
                      privacyPolicyUrl?: string;
                      redirectUris?: string[];
                      roleConnectionsVerificationUrl?: null | string;
                      rpcOrigins?: string[];
                      slug?: string;
                      tags?: [
                          string,
                          ((...) | (...))?,
                          ((...) | (...))?,
                          ((...) | (...))?,
                          ((...) | (...))?,
                      ];
                      team?: null | APITeam;
                      termsOfServiceUrl?: string;
                      verifyKey?: string;
                  };
                  targetType?: InviteTargetType;
                  targetUser?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  temporary: boolean;
                  type: InviteType;
                  uses: number;
              },
          >;
          delete: (
              code: string,
              reason?: string,
          ) => Promise<
              {
                  approximateMemberCount?: number;
                  approximatePresenceCount?: number;
                  channel: null
                  | { id: string; name: null | string; type: ChannelType };
                  code: string;
                  expiresAt?: null | string;
                  guild?: {
                      banner: null | string;
                      description: null | string;
                      features: GuildFeature[];
                      icon: null | string;
                      id: string;
                      name: string;
                      nsfwLevel: GuildNSFWLevel;
                      premiumSubscriptionCount?: number;
                      splash: null | string;
                      vanityUrlCode: null | string;
                      verificationLevel: GuildVerificationLevel;
                  };
                  guildScheduledEvent?: | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: StageInstance;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: Voice;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: null;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: { location: string };
                      entityType: External;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  };
                  inviter?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  targetApplication?: {
                      approximateGuildCount?: number;
                      approximateUserInstallCount?: number;
                      bot?: APIUser;
                      botPublic?: boolean;
                      botRequireCodeGrant?: boolean;
                      coverImage?: string;
                      customInstallUrl?: string;
                      description?: string;
                      flags?: ApplicationFlags;
                      guild?: APIPartialGuild;
                      guildId?: string;
                      icon?: null
                      | string;
                      id?: string;
                      installParams?: APIApplicationInstallParams;
                      integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
                      interactionsEndpointUrl?: null | string;
                      name?: string;
                      owner?: APIUser;
                      primarySkuId?: string;
                      privacyPolicyUrl?: string;
                      redirectUris?: string[];
                      roleConnectionsVerificationUrl?: null | string;
                      rpcOrigins?: string[];
                      slug?: string;
                      tags?: [
                          string,
                          ((...) | (...))?,
                          ((...) | (...))?,
                          ((...) | (...))?,
                          ((...) | (...))?,
                      ];
                      team?: null | APITeam;
                      termsOfServiceUrl?: string;
                      verifyKey?: string;
                  };
                  targetType?: InviteTargetType;
                  targetUser?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  type: InviteType;
              },
          >;
          list: () => Promise<
              {
                  approximateMemberCount?: number;
                  approximatePresenceCount?: number;
                  channel: null
                  | { id: string; name: null | string; type: ChannelType };
                  code: string;
                  createdAt: string;
                  expiresAt?: null | string;
                  guild?: {
                      banner: null | string;
                      description: null | string;
                      features: GuildFeature[];
                      icon: null | string;
                      id: string;
                      name: string;
                      nsfwLevel: GuildNSFWLevel;
                      premiumSubscriptionCount?: number;
                      splash: null | string;
                      vanityUrlCode: null | string;
                      verificationLevel: GuildVerificationLevel;
                  };
                  guildScheduledEvent?: | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: StageInstance;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: string;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: null;
                      entityType: Voice;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  }
                  | {
                      channelId: null;
                      creator?: APIUser;
                      creatorId?: null
                      | string;
                      description?: null | string;
                      entityId: null | string;
                      entityMetadata: { location: string };
                      entityType: External;
                      guildId: string;
                      id: string;
                      image?: null | string;
                      name: string;
                      privacyLevel: GuildScheduledEventPrivacyLevel;
                      recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
                      scheduledEndTime: null | string;
                      scheduledStartTime: string;
                      status: GuildScheduledEventStatus;
                      userCount?: number;
                  };
                  inviter?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  maxAge: number;
                  maxUses: number;
                  targetApplication?: {
                      approximateGuildCount?: number;
                      approximateUserInstallCount?: number;
                      bot?: APIUser;
                      botPublic?: boolean;
                      botRequireCodeGrant?: boolean;
                      coverImage?: string;
                      customInstallUrl?: string;
                      description?: string;
                      flags?: ApplicationFlags;
                      guild?: APIPartialGuild;
                      guildId?: string;
                      icon?: null
                      | string;
                      id?: string;
                      installParams?: APIApplicationInstallParams;
                      integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
                      interactionsEndpointUrl?: null | string;
                      name?: string;
                      owner?: APIUser;
                      primarySkuId?: string;
                      privacyPolicyUrl?: string;
                      redirectUris?: (...)[];
                      roleConnectionsVerificationUrl?: null | string;
                      rpcOrigins?: (...)[];
                      slug?: string;
                      tags?: [(...), (...)?, (...)?, (...)?, (...)?];
                      team?: null | APITeam;
                      termsOfServiceUrl?: string;
                      verifyKey?: string;
                  };
                  targetType?: InviteTargetType;
                  targetUser?: {
                      accentColor?: null
                      | number;
                      avatar: null | string;
                      avatarDecorationData?: null | APIAvatarDecorationData;
                      banner?: null | string;
                      bot?: boolean;
                      discriminator: string;
                      email?: null | string;
                      flags?: UserFlags;
                      globalName: null | string;
                      id: string;
                      locale?: string;
                      mfaEnabled?: boolean;
                      premiumType?: UserPremiumType;
                      publicFlags?: UserFlags;
                      system?: boolean;
                      username: string;
                      verified?: boolean;
                  };
                  temporary: boolean;
                  type: InviteType;
                  uses: number;
              }[],
          >;
      };
      name: string;
      nsfw?: boolean;
      parentId?: null
      | string;
      permissionOverwrites: {
          fetch: () => ReturnCache<
              | undefined
              | {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              }[],
          >;
          values: () => {
              allow: PermissionsBitField;
              deny: PermissionsBitField;
              guildId: string;
              id: string;
              type: number;
          }[][];
      };
      position: number;
      rest: ApiHandler;
      url: string;
      delete(reason?: string): Promise<AllChannels>;
      edit(
          ...args: [body: RESTPatchAPIChannelJSONBody, reason?: string],
      ): Promise<CategoryChannel>;
      fetch(mode?: "rest" | "flow"): Promise<AllChannels>;
      fetch(mode: "cache"): ReturnCache<undefined | AllChannels>;
      guild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>;
      guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>;
      is<T extends (keyof IChannelTypes)[]>(
          channelTypes: T,
      ): this is IChannelTypes[T[number]];
      isCategory(): this is CategoryChannel;
      isDirectory(): this is DirectoryChannel;
      isDM(): this is DMChannel;
      isForum(): this is ForumChannel;
      isGuildTextable(): this is AllGuildTextableChannels;
      isMedia(): this is MediaChannel;
      isNews(): this is NewsChannel;
      isStage(): this is StageChannel;
      isTextable(): this is AllTextableChannels;
      isTextGuild(): this is TextGuildChannel;
      isThread(): this is ThreadChannel;
      isThreadOnly(): this is MediaChannel | ForumChannel;
      isVoice(): this is VoiceChannel;
      memberPermissions(
          member: GuildMember,
          checkAdmin?: boolean,
      ): Promise<PermissionsBitField>;
      overwritesFor(
          member: GuildMember,
      ): Promise<
          {
              everyone: | undefined
              | {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              };
              member: | undefined
              | {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              };
              roles: {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              }[];
          },
      >;
      rolePermissions(
          role: GuildRole,
          checkAdmin?: boolean,
      ): Promise<PermissionsBitField>;
      setName(...args: [name: string, reason?: string]): Promise<CategoryChannel>;
      setNsfw(
          ...args: [nsfw: boolean, reason?: string],
      ): Promise<CategoryChannel>;
      setPosition(
          ...args: [position: number, reason?: string],
      ): Promise<CategoryChannel>;
      setRatelimitPerUser(
          ...args: [rate_limit_per_user: null | number],
      ): Promise<CategoryChannel>;
      toString(): `<#${string}>`;
  }
  • CategoryChannel