CategoryChannel

Extends

ObjectToLower<Omit<APIGuildCategoryChannel, "permission_overwrites">>.Object

Constructors

new CategoryChannel(args)

1
new CategoryChannel(...args: any[]): CategoryChannel

Parameters

Parameter	Type
…`args`	`any`[]

Returns

CategoryChannel

Inherited from

ObjectToLower<Omit<APIGuildCategoryChannel, 'permission_overwrites'>>.constructor

Source

seyfert/src/common/types/util.ts:3

Properties

Property	Modifier	Type	Inherited from
`api`	`public`	`APIRoutes`	-
`cache`	`public`	`Cache`	-
`client`	`readonly`	`UsingClient`	-
`createdAt`	`public`	`Date`	-
`createdTimestamp`	`public`	`number`	-
`flags`	`public`	`undefined` \| `ChannelFlags`	`ObjectToLower.flags`
`guildId`	`public`	`undefined` \| `string`	`ObjectToLower.guildId`
`id`	`public`	`string`	`ObjectToLower.id`
`name`	`public`	`string`	`ObjectToLower.name`
`nsfw`	`public`	`undefined` \| `boolean`	`ObjectToLower.nsfw`
`parentId`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.parentId`
`permissionOverwrites`	`public`	`Object`	-
`permissionOverwrites.fetch`	`public`	() => `ReturnCache`<`undefined` \| `Object`[]>	-
`permissionOverwrites.values`	`public`	() => `Object`[][]	-
`position`	`public`	`number`	`ObjectToLower.position`
`rest`	`public`	`ApiHandler`	-
`type`	`public`	`GuildCategory`	`ObjectToLower.type`
`url`	`public`	`string`	-

Methods

delete()

1
delete(reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:66

edit()

1
edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`body`	`RESTPatchAPIChannelJSONBody`
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:70

fetch()

1
fetch(force: boolean): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:62

guild()

1
guild(force: boolean): Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<Guild<"cached"> | Guild<"api">>

Source

seyfert/src/structures/channels.ts:190

is()

1
is<T>(channelTypes: T): this is IChannelTypes[T[number]]

Type parameters

Type parameter
`T` extends keyof `IChannelTypes`[]

Parameters

Parameter	Type
`channelTypes`	`T`

Returns

this is IChannelTypes[T[number]]

Source

seyfert/src/structures/channels.ts:133

isCategory()

1
isCategory(): this is CategoryChannel

Returns

this is CategoryChannel

Source

seyfert/src/structures/channels.ts:113

isDM()

1
isDM(): this is DMChannel

Returns

this is DMChannel

Source

seyfert/src/structures/channels.ts:89

isDirectory()

1
isDirectory(): this is DirectoryChannel

Returns

this is DirectoryChannel

Source

seyfert/src/structures/channels.ts:101

isForum()

1
isForum(): this is ForumChannel

Returns

this is ForumChannel

Source

seyfert/src/structures/channels.ts:93

isGuildTextable()

1
isGuildTextable(): this is AllGuildTextableChannels

Returns

this is AllGuildTextableChannels

Source

seyfert/src/structures/channels.ts:125

isMedia()

1
isMedia(): this is MediaChannel

Returns

this is MediaChannel

Source

seyfert/src/structures/channels.ts:85

isNews()

1
isNews(): this is NewsChannel

Returns

this is NewsChannel

Source

seyfert/src/structures/channels.ts:117

isStage()

1
isStage(): this is StageChannel

Returns

this is StageChannel

Source

seyfert/src/structures/channels.ts:81

isTextGuild()

1
isTextGuild(): this is TextGuildChannel

Returns

this is TextGuildChannel

Source

seyfert/src/structures/channels.ts:109

isTextable()

1
isTextable(): this is AllTextableChannels

Returns

this is AllTextableChannels

Source

seyfert/src/structures/channels.ts:121

isThread()

1
isThread(): this is ThreadChannel

Returns

this is ThreadChannel

Source

seyfert/src/structures/channels.ts:97

isThreadOnly()

1
isThreadOnly(): this is MediaChannel | ForumChannel

Returns

this is MediaChannel | ForumChannel

Source

seyfert/src/structures/channels.ts:129

isVoice()

1
isVoice(): this is VoiceChannel

Returns

this is VoiceChannel

Source

seyfert/src/structures/channels.ts:105

memberPermissions()

1
memberPermissions(member: GuildMember, checkAdmin: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
`member`	`GuildMember`	`undefined`
`checkAdmin`	`boolean`	`true`

Returns

Promise<PermissionsBitField>

Source

seyfert/src/structures/channels.ts:178

overwritesFor()

1
overwritesFor(member: GuildMember): Promise<Object>

Parameters

Parameter	Type
`member`	`GuildMember`

Returns

Promise<Object>

Member Type Value
everyone undefined | Object everyoneOverwrites
member undefined | Object memberOverwrites
roles Object[] roleOverwrites

Member	Type	Value
`everyone`	`undefined` \| `Object`	everyoneOverwrites
`member`	`undefined` \| `Object`	memberOverwrites
`roles`	`Object`[]	roleOverwrites

Source

seyfert/src/structures/channels.ts:186

rolePermissions()

1
rolePermissions(role: GuildRole, checkAdmin: boolean): Promise<PermissionsBitField>

Parameters

Parameter	Type	Default value
`role`	`GuildRole`	`undefined`
`checkAdmin`	`boolean`	`true`

Returns

Promise<PermissionsBitField>

Source

seyfert/src/structures/channels.ts:182

setName()

1
setName(name: string, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`name`	`string`
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:202

setPosition()

1
setPosition(position: number, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`position`	`number`
`reason`?	`string`

Returns

Promise<AllChannels>

Source

seyfert/src/structures/channels.ts:198

toString()

1
toString(): string

Returns

string

Source

seyfert/src/structures/channels.ts:77