BaseGuildChannel
Signature
export declare class BaseGuildChannel extends BaseChannel<ChannelType>Private types
IChannelTypesInterface
interface IChannelTypes { GuildStageVoice: StageChannel; GuildMedia: MediaChannel; DM: DMChannel; GuildForum: ForumChannel; AnnouncementThread: ThreadChannel; PrivateThread: ThreadChannel; PublicThread: ThreadChannel; GuildDirectory: DirectoryChannel; GuildVoice: VoiceChannel; GuildText: TextGuildChannel; GuildCategory: CategoryChannel; GuildAnnouncement: NewsChannel;}Properties
14Methods
30Properties
guildId: string;invites: { list: () => Promise<{ uses: number; maxUses: number; maxAge: number; temporary: boolean; createdAt: string; code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; roles?: { id: string; name: string; icon?: string | null | undefined; position: number; color: number; colors: { primaryColor: number; secondaryColor: number | null; tertiaryColor: number | null; }; unicodeEmoji?: string | null | undefined; } | undefined; }[]>; create: (data: Omit<CreateInviteFromChannel, "channelId">) => Promise<{ uses: number; maxUses: number; maxAge: number; temporary: boolean; createdAt: string; code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; }>; delete: (code: string, reason?: string) => Promise<{ code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; }>;};permissionOverwrites: { fetch: () => ReturnType<Overwrites["get"]>; values: () => ReturnCache<ReturnType<Overwrites["values"]>>; edit: (overwriteId: string, body: ChannelShorterOverwriteBody, reason?: string) => Promise<void>; delete: (overwriteId: string, reason?: string) => Promise<void>;};urlGetterget url(): `https://discord.com/channels/${string}/${string}`;The URL to the channel
type: T;id: string;createdTimestampGetterget createdTimestamp(): number;Create a timestamp for the current object.
createdAtGetterget createdAt(): Date;createdAt gets the creation Date instace of the current object.
readonly client: UsingClient;flags?: ChannelFlags | undefined;name: string;position: number;parentId?: string | null | undefined;nsfw?: boolean | undefined;Methods
constructorConstructorconstructor(client: UsingClient, data: APIGuildChannel<ChannelType>);memberPermissions(member: GuildMember, checkAdmin?: boolean): Promise<PermissionsBitField>;rolePermissions(role: GuildRole, checkAdmin?: boolean): Promise<PermissionsBitField>;overwritesFor(member: GuildMember): Promise<{ everyone: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; } | undefined; roles: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; }[]; member: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; } | undefined;}>;guild(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'>>;guild(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;setPosition(position: number, reason?: string): Promise<this>;setName(name: string, reason?: string): Promise<this>;setParent(parent_id: string | null, reason?: string): Promise<this>;setRatelimitPerUser(rate_limit_per_user: number | null | undefined): Promise<this>;setNsfw(nsfw?: boolean, reason?: string): Promise<this>;edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<this>;fetch(mode?: 'rest' | 'flow'): Promise<AllChannels>;fetch(mode: 'cache'): ReturnCache<AllChannels | undefined>;delete(reason?: string): Promise<this>;toString(): `<#${string}>`;Returns a string representation of an object.
isStage(): this is StageChannel;isMedia(): this is MediaChannel;isDM(): this is DMChannel;isForum(): this is ForumChannel;isThread(): this is ThreadChannel;isDirectory(): this is DirectoryChannel;isVoice(): this is VoiceChannel;isTextGuild(): this is TextGuildChannel;isCategory(): this is CategoryChannel;isNews(): this is NewsChannel;isTextable(): this is AllTextableChannels;isGuildTextable(): this is AllGuildTextableChannels;isNamed(): this is AllNamedChannels;isGuild(): this is AllGuildChannels | BaseGuildChannelStructure;isThreadOnly(): this is ForumChannel | MediaChannel;is<T extends (keyof IChannelTypes)[]>(channelTypes: T): this is IChannelTypes[T[number]];