ThreadShorter
Signature
export declare class ThreadShorter extends BaseShorterPrivate types
InferWithMemberOnListTypeAlias
type InferWithMemberOnList<T extends RESTGetAPIChannelThreadMembersQuery> = T extends { with_member: infer B;} ? B extends true ? Required<APIThreadMember>[] : GetAPIChannelThreadMemberResult[] : GetAPIChannelThreadMemberResult[];Properties
0No properties.
Methods
13Methods
create(channelId: string, body: ThreadCreateBodyRequest, reason?: string): Promise<ThreadChannelStructure>;Creates a new thread in the channel (only guild based channels).
Parameters
channelId- The ID of the parent channel.
reason- The reason for unpinning the message.
Returns
A promise that resolves when the thread is succesfully created.
fromMessage(channelId: string, messageId: string, options: RESTPostAPIChannelMessagesThreadsJSONBody & { reason?: string;}): Promise<ThreadChannelStructure>;join(threadId: string): Promise<undefined>;leave(threadId: string): Promise<undefined>;lock(threadId: string, locked?: boolean, reason?: string): Promise<ThreadChannelStructure>;edit(threadId: string, body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<ThreadChannelStructure>;removeMember(threadId: string, memberId: string): Promise<undefined>;fetchMember<WithMember extends boolean = false>(threadId: string, memberId: string, with_member: WithMember): Promise<When<WithMember, Required<APIThreadMember>, GetAPIChannelThreadMemberResult>>;addMember(threadId: string, memberId: string): Promise<undefined>;listMembers<T extends RESTGetAPIChannelThreadMembersQuery = RESTGetAPIChannelThreadMembersQuery>(threadId: string, query?: T): Promise<InferWithMemberOnList<T>>;listArchived(channelId: string, type: 'public' | 'private', query?: RESTGetAPIChannelThreadsArchivedQuery): Promise<{ threads: ThreadChannelStructure[]; members: GetAPIChannelThreadMemberResult[]; hasMore: boolean;}>;listGuildActive(guildId: string, force?: boolean): Promise<ThreadChannelStructure[]>;listJoinedArchivedPrivate(channelId: string, query?: RESTGetAPIChannelThreadsArchivedQuery): Promise<{ threads: ThreadChannelStructure[]; members: GetAPIChannelThreadMemberResult[]; hasMore: boolean;}>;