Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelBase

Basic Channel Structure

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysChannelBase

_keysMerge

_keysMerge: BaseSet<string> = keysMergeChannelBase

Optional _nicks

_nicks: BaseCollection<string, string>

Optional _permissionOverwrites

_permissionOverwrites: BaseCollection<string, Overwrite>

Optional _recipients

_recipients: BaseCollection<string, User>

Optional applicationId

applicationId: undefined | string

bitrate

bitrate: number = 0

client

client: ShardClient

deleted

deleted: boolean = false

guildId

guildId: string = ""

Optional icon

icon: null | string

id

id: string = ""

isPartial

isPartial: boolean = false

Optional lastMessageId

lastMessageId: null | string

lastPinTimestampUnix

lastPinTimestampUnix: number = 0

name

name: string

nsfw

nsfw: boolean = false

Optional parentId

parentId: null | string

position

position: number = -1

rateLimitPerUser

rateLimitPerUser: number = 0

Optional topic

topic: undefined | string

type

type: ChannelTypes = ChannelTypes.BASE

userLimit

userLimit: number = 0

Accessors

canAddReactions

  • get canAddReactions(): boolean

  • Returns boolean

canAttachFiles

  • get canAttachFiles(): boolean

  • Returns boolean

canDeafenMembers

  • get canDeafenMembers(): boolean

  • Returns boolean

canEdit

  • get canEdit(): boolean

  • Returns boolean

canEmbedLinks

  • get canEmbedLinks(): boolean

  • Returns boolean

canJoin

  • get canJoin(): boolean

  • Returns boolean

canManageMessages

  • get canManageMessages(): boolean

  • Returns boolean

canManageWebhooks

  • get canManageWebhooks(): boolean

  • Returns boolean

canMentionEveryone

  • get canMentionEveryone(): boolean

  • Returns boolean

canMessage

  • get canMessage(): boolean

  • Returns boolean

canMoveMembers

  • get canMoveMembers(): boolean

  • Returns boolean

canMuteMembers

  • get canMuteMembers(): boolean

  • Returns boolean

canPrioritySpeaker

  • get canPrioritySpeaker(): boolean

  • Returns boolean

canReadHistory

  • get canReadHistory(): boolean

  • Returns boolean

canSendTTSMessage

  • get canSendTTSMessage(): boolean

  • Returns boolean

canSpeak

  • get canSpeak(): boolean

  • Returns boolean

canStream

  • get canStream(): boolean

  • Returns boolean

canUseExternalEmojis

  • get canUseExternalEmojis(): boolean

  • Returns boolean

canUseVAD

  • get canUseVAD(): boolean

  • Returns boolean

canView

  • get canView(): boolean

  • Returns boolean

children

  • Returns BaseCollection<string, ChannelGuildBase>

createdAt

  • get createdAt(): Date

  • Returns Date

createdAtUnix

  • get createdAtUnix(): number

  • Returns number

defaultIconUrl

  • get defaultIconUrl(): null | string

  • Returns null | string

guild

  • get guild(): Guild | null

  • Returns Guild | null

iconUrl

  • get iconUrl(): null | string

  • Returns null | string

isDm

  • get isDm(): boolean

  • Returns boolean

isDmGroup

  • get isDmGroup(): boolean

  • Returns boolean

isDmSingle

  • get isDmSingle(): boolean

  • Returns boolean

isGuildCategory

  • get isGuildCategory(): boolean

  • Returns boolean

isGuildChannel

  • get isGuildChannel(): boolean

  • Returns boolean

isGuildNews

  • get isGuildNews(): boolean

  • Returns boolean

isGuildStore

  • get isGuildStore(): boolean

  • Returns boolean

isGuildText

  • get isGuildText(): boolean

  • Returns boolean

isGuildVoice

  • get isGuildVoice(): boolean

  • Returns boolean

isManaged

  • get isManaged(): boolean

  • Returns boolean

isSyncedWithParent

  • get isSyncedWithParent(): boolean

  • Returns boolean

isText

  • get isText(): boolean

  • Returns boolean

isVoice

  • get isVoice(): boolean

  • Returns boolean

joined

  • get joined(): boolean

  • Returns boolean

jumpLink

  • get jumpLink(): string

  • Returns string

lastPinTimestamp

  • get lastPinTimestamp(): Date | null

  • Returns Date | null

members

  • get members(): BaseCollection<string, Member>

  • Returns BaseCollection<string, Member>

mention

  • get mention(): string

  • Returns string

messages

  • get messages(): BaseCollection<string, Message>

  • Returns BaseCollection<string, Message>

nicks

  • get nicks(): BaseCollection<string, string>

  • Returns BaseCollection<string, string>

owner

  • get owner(): User | null

  • Returns User | null

parent

permissionOverwrites

  • get permissionOverwrites(): BaseCollection<string, Overwrite>

  • Returns BaseCollection<string, Overwrite>

recipients

  • get recipients(): BaseCollection<string, User>

  • Returns BaseCollection<string, User>

shardId

  • get shardId(): number

  • Returns number

typing

  • get typing(): BaseCollection<string, Typing>

  • Returns BaseCollection<string, Typing>

voiceStates

  • get voiceStates(): BaseCollection<string, VoiceState>

  • Returns BaseCollection<string, VoiceState>

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any

  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any

  • Parameters

    • key: string
    • value: any

    Returns any

addPinnedMessage

  • addPinnedMessage(messageId: string): Promise<any>

  • Parameters

    • messageId: string

    Returns Promise<any>

addRecipient

  • addRecipient(userId: string): Promise<any>

  • Parameters

    • userId: string

    Returns Promise<any>

bulkDelete

  • bulkDelete(messageIds: Array<string>): Promise<any>

  • Parameters

    • messageIds: Array<string>

    Returns Promise<any>

can

  • can(permissions: PermissionTools.PermissionChecks, memberOrRole?: Member | Role): boolean

  • Parameters

    • permissions: PermissionTools.PermissionChecks
    • Optional memberOrRole: Member | Role

    Returns boolean

close

  • close(): Promise<any>

  • Returns Promise<any>

createInvite

  • createInvite(options: CreateChannelInvite): Promise<Invite>

  • Parameters

    • options: CreateChannelInvite

    Returns Promise<Invite>

createMessage

  • createMessage(options?: CreateMessage | string): Promise<any>

  • Parameters

    • Default value options: CreateMessage | string = {}

    Returns Promise<any>

createReaction

  • createReaction(messageId: string, emoji: string): Promise<any>

  • Parameters

    • messageId: string
    • emoji: string

    Returns Promise<any>

createWebhook

  • createWebhook(options: CreateWebhook): Promise<any>

  • Parameters

    • options: CreateWebhook

    Returns Promise<any>

delete

deleteMessage

  • deleteMessage(messageId: string, options?: DeleteMessage): Promise<any>

  • Parameters

    • messageId: string
    • Default value options: DeleteMessage = {}

    Returns Promise<any>

deleteOverwrite

  • deleteOverwrite(overwriteId: string, options?: DeleteChannelOverwrite): Promise<any>

  • Parameters

    • overwriteId: string
    • Default value options: DeleteChannelOverwrite = {}

    Returns Promise<any>

deletePin

  • deletePin(messageId: string): Promise<any>

  • Parameters

    • messageId: string

    Returns Promise<any>

deleteReaction

  • deleteReaction(messageId: string, emoji: string, userId?: string): Promise<any>

  • Parameters

    • messageId: string
    • emoji: string
    • Default value userId: string = "@me"

    Returns Promise<any>

deleteReactions

  • deleteReactions(messageId: string): Promise<any>

  • Parameters

    • messageId: string

    Returns Promise<any>

difference

  • difference(key: string, value: any): [boolean, any]

  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

edit

  • edit(options?: EditChannel): Promise<any>

  • Parameters

    • Default value options: EditChannel = {}

    Returns Promise<any>

editMessage

  • editMessage(messageId: string, options?: EditMessage): Promise<any>

  • Parameters

    • messageId: string
    • Default value options: EditMessage = {}

    Returns Promise<any>

editOverwrite

  • editOverwrite(overwriteId: string, options?: EditChannelOverwrite): Promise<any>

  • Parameters

    • overwriteId: string
    • Default value options: EditChannelOverwrite = {}

    Returns Promise<any>

fetchCallStatus

  • fetchCallStatus(): Promise<any>

  • Returns Promise<any>

fetchInvites

  • fetchInvites(): Promise<BaseCollection<string, Invite>>

  • Returns Promise<BaseCollection<string, Invite>>

fetchMessage

  • fetchMessage(messageId: string): Promise<any>

  • Parameters

    • messageId: string

    Returns Promise<any>

fetchMessages

  • fetchMessages(options?: FetchMessages): Promise<any>

  • Parameters

    • Default value options: FetchMessages = {}

    Returns Promise<any>

fetchPins

  • fetchPins(): Promise<any>

  • Returns Promise<any>

fetchReactions

  • fetchReactions(messageId: string, emoji: string, options?: FetchReactions): Promise<any>

  • Parameters

    • messageId: string
    • emoji: string
    • Default value options: FetchReactions = {}

    Returns Promise<any>

fetchStoreListing

  • fetchStoreListing(): Promise<any>

  • Returns Promise<any>

fetchWebhooks

  • fetchWebhooks(): Promise<any>

  • Returns Promise<any>

grantEntitlement

  • grantEntitlement(): Promise<any>

  • Returns Promise<any>

iconUrlFormat

  • iconUrlFormat(format?: null | string, query?: UrlQuery): null | string

  • Parameters

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

isSyncedWith

  • Parameters

    Returns boolean

join

  • join(...args: any[]): Promise<any>

  • Parameters

    • Rest ...args: any[]

    Returns Promise<any>

merge

mergeValue

  • mergeValue(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

publish

  • publish(options: CreateApplicationNews): Promise<any>

  • Parameters

    • options: CreateApplicationNews

    Returns Promise<any>

removeRecipient

  • removeRecipient(userId: string): Promise<any>

  • Parameters

    • userId: string

    Returns Promise<any>

search

  • search(options: SearchOptions, retry?: undefined | false | true): Promise<any>

  • Parameters

    • options: SearchOptions
    • Optional retry: undefined | false | true

    Returns Promise<any>

startCallRinging

  • startCallRinging(recipients?: Array<string>): Promise<any>

  • Parameters

    • Optional recipients: Array<string>

    Returns Promise<any>

stopCallRinging

  • stopCallRinging(recipients?: Array<string>): Promise<any>

  • Parameters

    • Optional recipients: Array<string>

    Returns Promise<any>

toJSON

  • toJSON(): object

  • Returns object

toString

  • toString(): string

  • Returns string

triggerTyping

  • triggerTyping(): Promise<any>

  • Returns Promise<any>

turnIntoNewsChannel

  • turnIntoNewsChannel(): Promise<any>

  • Returns Promise<any>

turnIntoTextChannel

  • turnIntoTextChannel(): Promise<any>

  • Returns Promise<any>

unack

  • unack(): Promise<any>

  • Returns Promise<any>

Generated using TypeDoc