Interface PrivateThreadChannel

Construct a type with the properties of T except for those in type K.

interface PrivateThreadChannel {
    appliedTags: string[];
    archived: null | boolean;
    archiveTimestamp: null | number;
    autoArchiveDuration: null | ThreadAutoArchiveDuration;
    client: Client<true>;
    flags: Readonly<ChannelFlagsBitField>;
    guild: Guild;
    guildId: string;
    id: string;
    invitable: null | boolean;
    lastMessage: null | Message<boolean>;
    lastMessageId: null | string;
    lastPinAt: null | Date;
    lastPinTimestamp: null | number;
    locked: null | boolean;
    memberCount: null | number;
    members: ThreadMemberManager;
    messageCount: null | number;
    messages: GuildMessageManager;
    name: string;
    ownerId: string;
    parentId: null | string;
    rateLimitPerUser: null | number;
    totalMessageSent: null | number;
    type: PrivateThread;
    get archivedAt(): null | Date;
    get createdAt(): Date;
    get createdTimestamp(): number;
    get editable(): boolean;
    get guildMembers(): Collection<string, GuildMember>;
    get joinable(): boolean;
    get joined(): boolean;
    get manageable(): boolean;
    get parent(): | null
    | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>;
    get partial(): false;
    get sendable(): boolean;
    get unarchivable(): boolean;
    get url(): string;
    get viewable(): boolean;
    awaitMessageComponent<ComponentType extends MessageComponentType>(
        options?: AwaitMessageCollectorOptionsParams<ComponentType, true>,
    ): Promise<MappedInteractionTypes<boolean>[ComponentType]>;
    awaitMessages(
        options?: AwaitMessagesOptions,
    ): Promise<Collection<string, Message<boolean>>>;
    bulkDelete(
        messages:
            | number
            | Collection<string, Message<boolean>>
            | readonly MessageResolvable[],
        filterOld?: boolean,
    ): Promise<
        Collection<string, undefined | Message<boolean> | PartialMessage>,
    >;
    createMessageCollector(options?: MessageCollectorOptions): MessageCollector;
    createMessageComponentCollector<ComponentType extends MessageComponentType>(
        options?: MessageChannelCollectorOptionsParams<ComponentType, true>,
    ): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>;
    delete(reason?: string): Promise<PrivateThreadChannel>;
    edit(options: ThreadEditOptions): Promise<PrivateThreadChannel>;
    fetch(force?: boolean): Promise<PrivateThreadChannel>;
    fetchOwner(
        options?: FetchThreadOwnerOptions,
    ): Promise<null | ThreadMember<boolean>>;
    fetchStarterMessage(
        options?: BaseFetchOptions,
    ): Promise<null | Message<true>>;
    isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel;
    isSendable(): this is SendableChannels;
    isTextBased(): this is TextBasedChannel;
    isThread(): this is AnyThreadChannel;
    isThreadOnly(): this is ThreadOnlyChannel;
    isVoiceBased(): this is VoiceBasedChannel;
    join(): Promise<PrivateThreadChannel>;
    leave(): Promise<PrivateThreadChannel>;
    permissionsFor(
        memberOrRole: GuildMember | Role,
        checkAdmin?: boolean,
    ): Readonly<PermissionsBitField>;
    permissionsFor(
        memberOrRole:
            | string
            | User
            | GuildMember
            | Role
            | Message<boolean>
            | ThreadMember<boolean>,
        checkAdmin?: boolean,
    ): null | Readonly<PermissionsBitField>;
    pin(reason?: string): Promise<never>;
    send(
        options: string | MessagePayload | MessageCreateOptions,
    ): Promise<Message<true>>;
    sendTyping(): Promise<void>;
    setAppliedTags(
        appliedTags: readonly string[],
        reason?: string,
    ): Promise<never>;
    setArchived(
        archived?: boolean,
        reason?: string,
    ): Promise<PrivateThreadChannel>;
    setAutoArchiveDuration(
        autoArchiveDuration: ThreadAutoArchiveDuration,
        reason?: string,
    ): Promise<PrivateThreadChannel>;
    setInvitable(
        invitable?: boolean,
        reason?: string,
    ): Promise<PrivateThreadChannel>;
    setLocked(locked?: boolean, reason?: string): Promise<PrivateThreadChannel>;
    setName(name: string, reason?: string): Promise<PrivateThreadChannel>;
    setRateLimitPerUser(
        rateLimitPerUser: number,
        reason?: string,
    ): Promise<TextBasedChannelFields<true, boolean>>;
    toJSON(...props: Record<string, string | boolean>[]): unknown;
    toString(): `<#${string}>`;
    unpin(reason?: string): Promise<never>;
    valueOf(): string;
}

Hierarchy (View Summary)

Properties

appliedTags archived archiveTimestamp autoArchiveDuration client flags guild guildId id invitable lastMessage lastMessageId lastPinAt lastPinTimestamp locked memberCount members messageCount messages name ownerId parentId rateLimitPerUser totalMessageSent type

Accessors

archivedAt createdAt createdTimestamp editable guildMembers joinable joined manageable parent partial sendable unarchivable url viewable

Methods

awaitMessageComponent awaitMessages bulkDelete createMessageCollector createMessageComponentCollector delete edit fetch fetchOwner fetchStarterMessage isDMBased isSendable isTextBased isThread isThreadOnly isVoiceBased join leave permissionsFor pin send sendTyping setAppliedTags setArchived setAutoArchiveDuration setInvitable setLocked setName setRateLimitPerUser toJSON toString unpin valueOf

Properties

appliedTags

appliedTags: string[]

archived

archived: null | boolean

archiveTimestamp

archiveTimestamp: null | number

autoArchiveDuration

autoArchiveDuration: null | ThreadAutoArchiveDuration

Readonlyclient

client: Client<true>

flags

flags: Readonly<ChannelFlagsBitField>

guild

guild: Guild

guildId

guildId: string

id

id: string

invitable

invitable: null | boolean

lastMessage

lastMessage: null | Message<boolean>

lastMessageId

lastMessageId: null | string

lastPinAt

lastPinAt: null | Date

lastPinTimestamp

lastPinTimestamp: null | number

locked

locked: null | boolean

memberCount

memberCount: null | number

members

members: ThreadMemberManager

messageCount

messageCount: null | number

messages

messages: GuildMessageManager

name

name: string

ownerId

ownerId: string

parentId

parentId: null | string

rateLimitPerUser

rateLimitPerUser: null | number

totalMessageSent

totalMessageSent: null | number

type

type: PrivateThread

Accessors

archivedAt

  • get archivedAt(): null | Date

    Returns null | Date

createdAt

  • get createdAt(): Date

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

    Returns number

editable

  • get editable(): boolean

    Returns boolean

guildMembers

joinable

  • get joinable(): boolean

    Returns boolean

joined

  • get joined(): boolean

    Returns boolean

manageable

  • get manageable(): boolean

    Returns boolean

parent

partial

  • get partial(): false

    Returns false

sendable

  • get sendable(): boolean

    Returns boolean

unarchivable

  • get unarchivable(): boolean

    Returns boolean

url

  • get url(): string

    Returns string

viewable

  • get viewable(): boolean

    Returns boolean

Methods

awaitMessageComponent

awaitMessages

bulkDelete

createMessageCollector

createMessageComponentCollector

delete

edit

fetch

fetchOwner

fetchStarterMessage

isDMBased

isSendable

isTextBased

isThread

isThreadOnly

isVoiceBased

join

leave

permissionsFor

pin

  • pin(reason?: string): Promise<never>

    Parameters

    • Optionalreason: string

    Returns Promise<never>

send

sendTyping

setAppliedTags

  • setAppliedTags(appliedTags: readonly string[], reason?: string): Promise<never>

    Parameters

    • appliedTags: readonly string[]
    • Optionalreason: string

    Returns Promise<never>

setArchived

setAutoArchiveDuration

setInvitable

setLocked

setName

setRateLimitPerUser

toJSON

  • toJSON(...props: Record<string, string | boolean>[]): unknown

    Parameters

    • ...props: Record<string, string | boolean>[]

    Returns unknown

toString

  • toString(): `<#${string}>`

    Returns a string representation of an object.

    Returns `<#${string}>`

unpin

  • unpin(reason?: string): Promise<never>

    Parameters

    • Optionalreason: string

    Returns Promise<never>

valueOf

  • valueOf(): string

    Returns string

Settings

Member Visibility

On This Page

Properties
Accessors
Methods