new ChannelBase
src/structures/channel.ts:187new ChannelBase(client: ShardClient, data?: BaseStructureData, isClone?: boolean)On this page
Basic Channel Structure
import { Structures } from 'detritus-client';
Structures.ChannelBase;Hierarchy
Subclasses
Constructor
Properties
optional
optional
optional
optional
optional
optional
optional
optional
optional
Accessors
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
Methods
_getFromSnake()
src/structures/basestructure.ts:138_getFromSnake(key: string): anyInherited from BaseStructure._getFromSnake
_setFromSnake()
src/structures/basestructure.ts:142_setFromSnake(key: string, value: any): anyInherited from BaseStructure._setFromSnake
[custom]()
src/structures/basestructure.ts:388[custom](): objectInherited from BaseStructure.[custom]
addMember()
async src/structures/channel.ts:613addMember(userId: string): Promise<any>addPinnedMessage()
async src/structures/channel.ts:606addPinnedMessage(messageId: string): Promise<any>addRecipient()
async src/structures/channel.ts:620addRecipient(userId: string, options?: AddRecipient): Promise<any>bulkDelete()
async src/structures/channel.ts:627bulkDelete(messageIds: string[]): Promise<any>can()
src/structures/channel.ts:584can(permissions: PermissionChecks, memberOrRole?: Member | Role): booleanclone()
src/structures/basestructure.ts:431clone(): thisInherited from BaseStructure.clone
close()
async src/structures/channel.ts:634close(): Promise<Channel>createInvite()
async src/structures/channel.ts:641createInvite(options: CreateChannelInvite): Promise<Invite>createMessage()
async src/structures/channel.ts:645createMessage(options?: string | CreateMessage): Promise<Message>createReaction()
async src/structures/channel.ts:652createReaction(messageId: string, emoji: string): Promise<any>createStageInstance()
async src/structures/channel.ts:659createStageInstance(
options: PartialBy<CreateStageInstance, "channelId">,
): Promise<StageInstance>createThread()
async src/structures/channel.ts:669createThread(options: CreateChannelThread): Promise<ChannelGuildThread>createWebhook()
async src/structures/channel.ts:676createWebhook(options: CreateWebhook): Promise<Webhook>crosspostMessage()
async src/structures/channel.ts:683crosspostMessage(messageId: string): Promise<Message>delete()
async src/structures/channel.ts:690delete(options?: DeleteChannel): Promise<Channel>deleteMessage()
async src/structures/channel.ts:694deleteMessage(messageId: string, options?: DeleteMessage): Promise<any>deleteOverwrite()
async src/structures/channel.ts:701deleteOverwrite(overwriteId: string, options?: DeleteChannelOverwrite): Promise<any>deletePin()
async src/structures/channel.ts:708deletePin(messageId: string): Promise<any>deleteReaction()
async src/structures/channel.ts:715deleteReaction(messageId: string, emoji: string, userId?: string): Promise<any>Parameters
messageId
string
emoji
string
userId?
string
deleteReactions()
async src/structures/channel.ts:722deleteReactions(messageId: string): Promise<any>deleteStageInstance()
async src/structures/channel.ts:729deleteStageInstance(): Promise<any>difference()
src/structures/basestructure.ts:146difference(key: string, value: any): [boolean, any]Inherited from BaseStructure.difference
differences()
src/structures/basestructure.ts:178differences(data?: BaseStructureData): object | nullInherited from BaseStructure.differences
differencesBetween()
src/structures/basestructure.ts:197differencesBetween(structure: Structure): object | nullInherited from BaseStructure.differencesBetween
edit()
async src/structures/channel.ts:736edit(options?: EditChannel): Promise<Channel>editMessage()
async src/structures/channel.ts:740editMessage(messageId: string, options?: EditMessage): Promise<Message>editOverwrite()
async src/structures/channel.ts:747editOverwrite(overwriteId: string, options?: EditChannelOverwrite): Promise<any>editStageInstance()
async src/structures/channel.ts:754editStageInstance(options?: EditStageInstance): Promise<any>fetchCallStatus()
async src/structures/channel.ts:761fetchCallStatus(): Promise<any>fetchInvites()
async src/structures/channel.ts:768fetchInvites(): Promise<BaseCollection<string, Invite>>fetchMembers()
async src/structures/channel.ts:772fetchMembers(options?: FetchThreadMembers): Promise<BaseCollection<string, ThreadMember>>fetchMessage()
async src/structures/channel.ts:779fetchMessage(messageId: string): Promise<Message>fetchMessages()
async src/structures/channel.ts:786fetchMessages(options?: FetchMessages): Promise<BaseCollection<string, Message>>fetchPins()
async src/structures/channel.ts:793fetchPins(): Promise<BaseCollection<string, Message>>fetchReactions()
async src/structures/channel.ts:800fetchReactions(
messageId: string,
emoji: string,
options?: FetchReactions,
): Promise<BaseCollection<string, User>>fetchStageInstance()
async src/structures/channel.ts:807fetchStageInstance(): Promise<StageInstance>fetchStoreListing()
async src/structures/channel.ts:814fetchStoreListing(): Promise<StoreListing>fetchThreadsActive()
async src/structures/channel.ts:821fetchThreadsActive(): Promise<FetchChannelThreadsActive>fetchThreadsArchivedPrivate()
async src/structures/channel.ts:828fetchThreadsArchivedPrivate(
options?: FetchChannelThreadsArchivedPrivate,
): Promise<FetchChannelThreadsArchivedPrivate>fetchThreadsArchivedPrivateJoined()
async src/structures/channel.ts:835fetchThreadsArchivedPrivateJoined(
options?: FetchChannelThreadsArchivedPrivateJoined,
): Promise<FetchChannelThreadsArchivedPrivateJoined>fetchThreadsArchivedPublic()
async src/structures/channel.ts:842fetchThreadsArchivedPublic(
options?: FetchChannelThreadsArchivedPublic,
): Promise<FetchChannelThreadsArchivedPublic>fetchWebhooks()
async src/structures/channel.ts:849fetchWebhooks(): Promise<BaseCollection<string, Webhook>>follow()
async src/structures/channel.ts:856follow(options: FollowChannel): Promise<{ channelId: string; webhookId: string }>grantEntitlement()
async src/structures/channel.ts:863grantEntitlement(): Promise<void>hasDifference()
src/structures/basestructure.ts:218hasDifference(key: string, value: any): booleanInherited from BaseStructure.hasDifference
hasDifferences()
src/structures/basestructure.ts:293hasDifferences(data?: BaseStructureData): booleanInherited from BaseStructure.hasDifferences
hasDifferencesBetween()
src/structures/basestructure.ts:308hasDifferencesBetween(structure: Structure): booleanInherited from BaseStructure.hasDifferencesBetween
hasFlag()
src/structures/channel.ts:591hasFlag(flag: number): booleaniconUrlFormat()
src/structures/channel.ts:598iconUrlFormat(format?: string | null, query?: UrlQuery): string | nullisSyncedWith()
src/structures/channel.ts:602isSyncedWith(parent: ChannelGuildCategory | null): booleanjoin()
async src/structures/channel.ts:869join(): Promise<void>join(options?: CallOptions): Promise<VoiceConnectObject | null>leave()
async src/structures/channel.ts:889leave(): Promise<any>merge()
src/structures/channel.ts:963merge(data?: BaseStructureData): voidOverrides BaseStructure.merge
mergeValue()
src/structures/basestructure.ts:351mergeValue(key: string, value: any): voidInherited from BaseStructure.mergeValue
removeMember()
async src/structures/channel.ts:896removeMember(userId: string): Promise<any>removeRecipient()
async src/structures/channel.ts:903removeRecipient(userId: string): Promise<any>search()
async src/structures/channel.ts:910search(options: SearchOptions, retry?: boolean): Promise<any>startCallRinging()
async src/structures/channel.ts:917startCallRinging(recipients?: string[]): Promise<any>stopCallRinging()
async src/structures/channel.ts:924stopCallRinging(recipients?: string[]): Promise<any>toJSON()
src/structures/basestructure.ts:357toJSON(): objectInherited from BaseStructure.toJSON
toString()
src/structures/channel.ts:982toString(): stringReturns a string representation of an object.
triggerTyping()
async src/structures/channel.ts:931triggerTyping(): Promise<any>turnIntoNewsChannel()
async src/structures/channel.ts:938turnIntoNewsChannel(): Promise<Channel>turnIntoTextChannel()
async src/structures/channel.ts:947turnIntoTextChannel(): Promise<Channel>unack()
async src/structures/channel.ts:956unack(): Promise<any>