Class Channel

The base Channel class to interact with discord's api.

since: 1.0.0

Hierarchy

Channel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Channel(data: Channel): Channel

- Defined in lib/discord/Channel.ts:35
Parameters
- data: Channel
Returns Channel

Properties

Protected data

data: Channel

type

type: "Text" | "Dm" | "Voice" | "GroupDM" | "Category" | "News" | "Store" | "NewsThread" | "PublicThread" | "PrivateThread" | "StageVoice" = ...

Accessors

id

get id(): string

- Defined in lib/discord/Channel.ts:58
Returns the id of a channel.

Returns string

isDM

get isDM(): boolean

- Defined in lib/discord/Channel.ts:87
Checks if the channel is a of type 'DM'

Returns boolean
boolean

isNSFW

get isNSFW(): boolean

- Defined in lib/discord/Channel.ts:76
Checks if the channel is nsfw or not.

Returns boolean
boolean

name

get name(): string

- Defined in lib/discord/Channel.ts:68
Returns the name of the channel

Returns string

parentId

get parentId(): string

- Defined in lib/discord/Channel.ts:139
If a channel is in a category, it will have a parent id. This function will return that id

Returns string

perms

get perms(): string

- Defined in lib/discord/Channel.ts:135
Returns the channel permissions

Returns string

position

get position(): number

- Defined in lib/discord/Channel.ts:80
The position of the channel in the guild.

Returns number

subject

get subject(): string

- Defined in lib/discord/Channel.ts:71
Returns string

userLimit

get userLimit(): number

- Defined in lib/discord/Channel.ts:64
This property is only for voice channels

Returns number

Methods

getMessages

getMessages(amount?: number, data?: MessageSearchTerms): Promise<Message[]>

- Defined in lib/discord/Channel.ts:48
Fetch Messages from a channel.

Parameters
- amount: number = 50
  
  the amount of messages to fetch. defaults to 50.
- Optional data: MessageSearchTerms
Returns Promise<Message[]>
a map of messages from the channel.

getPins

getPins(): Promise<Message[]>

- Defined in lib/discord/Channel.ts:143
Returns the id of a pined message

Returns Promise<Message[]>

send

send(...messages: MessageForm[]): Promise<Message[]>

- Defined in lib/discord/Channel.ts:98
A function to send data to a channel. Works with embeds and normal text messages.
example
```
channel.send({content: "Leave a star on Fuwa.js!"})
```
Parameters
- Rest ...messages: MessageForm[]
Returns Promise<Message[]>

startTyping

startTyping(): Promise<void>

- Defined in lib/discord/Channel.ts:151
! WARNING: This method is not recommend to be used

see
https://discord.com/developers/docs/resources/channel#trigger-typing-indicator This makes the bot appear to be typing

Returns Promise<void>

Static get

get(id: string, force?: boolean): Promise<Channel>

- Defined in lib/discord/Channel.ts:161
Allows the API to fetch all base channel information.

Parameters
- id: string
  
  the ID of the channel.
- force: boolean = false
  
  by default we search the bot cache only, but if forced = true it will search the discord api if no channel is in the cache.
Returns Promise<Channel>
fuwa.js#Channel