NewsChannel

Extends

ObjectToLower<APINewsChannel>.WebhookChannelMethods.BaseChannel<ChannelType.GuildAnnouncement>

Constructors

new NewsChannel(client, data)

1
new NewsChannel(client: UsingClient, data: APIChannelBase<ChannelType>): NewsChannel

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`APIChannelBase`<`ChannelType`>

Properties

Property	Modifier	Type	Inherited from
`client`	`readonly`	`UsingClient`	`BaseChannel`.`client`
`defaultAutoArchiveDuration`	`public`	`undefined` \| `ThreadAutoArchiveDuration`	`ObjectToLower.defaultAutoArchiveDuration`
`defaultThreadRateLimitPerUser`	`public`	`undefined` \| `number`	`ObjectToLower.defaultThreadRateLimitPerUser`
`flags`	`public`	`undefined` \| `ChannelFlags`	`ObjectToLower.flags`
`guildId`	`public`	`undefined` \| `string`	`ObjectToLower.guildId`
`id`	`public`	`string`	`BaseChannel`.`id`
`lastMessageId`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.lastMessageId`
`lastPinTimestamp`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.lastPinTimestamp`
`name`	`public`	`string`	`ObjectToLower.name`
`nsfw`	`public`	`undefined` \| `boolean`	`ObjectToLower.nsfw`
`parentId`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.parentId`
`permissionOverwrites`	`public`	`undefined` \| `Object`[]	`ObjectToLower.permissionOverwrites`
`position`	`public`	`number`	`ObjectToLower.position`
`rateLimitPerUser`	`public`	`undefined` \| `number`	`ObjectToLower.rateLimitPerUser`
`topic`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.topic`
`type`	`public`	`GuildAnnouncement`	`BaseChannel`.`type`
`webhooks`	`public`	`Object`	`WebhookChannelMethods`.`webhooks`
`webhooks.create`	`public`	(`body`: `RESTPostAPIChannelWebhookJSONBody`) => `Promise`<`Webhook`>	-
`webhooks.list`	`public`	() => `Promise`<`Webhook`[]>	-

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

url

1
get url(): string

The URL to the channel

Returns

string

Source

seyfert/src/structures/channels.ts:58

Methods

addFollower()

1
addFollower(webhookChannelId: string, reason?: string): Promise<APIFollowedChannel>

Parameters

Parameter	Type
`webhookChannelId`	`string`
`reason`?	`string`

Returns

Promise<APIFollowedChannel>

Source

seyfert/src/structures/channels.ts:526

delete()

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

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.delete

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>

Inherited from

BaseChannel.edit

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>

Inherited from

BaseChannel.fetch

Source

seyfert/src/structures/channels.ts:62

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]]

Inherited from

BaseChannel.is

Source

seyfert/src/structures/channels.ts:133

isCategory()

1
isCategory(): this is CategoryChannel

Returns

this is CategoryChannel

Inherited from

BaseChannel.isCategory

Source

seyfert/src/structures/channels.ts:113

isDM()

1
isDM(): this is DMChannel

Returns

this is DMChannel

Inherited from

BaseChannel.isDM

Source

seyfert/src/structures/channels.ts:89

isDirectory()

1
isDirectory(): this is DirectoryChannel

Returns

this is DirectoryChannel

Inherited from

BaseChannel.isDirectory

Source

seyfert/src/structures/channels.ts:101

isForum()

1
isForum(): this is ForumChannel

Returns

this is ForumChannel

Inherited from

BaseChannel.isForum

Source

seyfert/src/structures/channels.ts:93

isGuildTextable()

1
isGuildTextable(): this is AllGuildTextableChannels

Returns

this is AllGuildTextableChannels

Inherited from

BaseChannel.isGuildTextable

Source

seyfert/src/structures/channels.ts:125

isMedia()

1
isMedia(): this is MediaChannel

Returns

this is MediaChannel

Inherited from

BaseChannel.isMedia

Source

seyfert/src/structures/channels.ts:85

isNews()

1
isNews(): this is NewsChannel

Returns

this is NewsChannel

Inherited from

BaseChannel.isNews

Source

seyfert/src/structures/channels.ts:117

isStage()

1
isStage(): this is StageChannel

Returns

this is StageChannel

Inherited from

BaseChannel.isStage

Source

seyfert/src/structures/channels.ts:81

isTextGuild()

1
isTextGuild(): this is TextGuildChannel

Returns

this is TextGuildChannel

Inherited from

BaseChannel.isTextGuild

Source

seyfert/src/structures/channels.ts:109

isTextable()

1
isTextable(): this is AllTextableChannels

Returns

this is AllTextableChannels

Inherited from

BaseChannel.isTextable

Source

seyfert/src/structures/channels.ts:121

isThread()

1
isThread(): this is ThreadChannel

Returns

this is ThreadChannel

Inherited from

BaseChannel.isThread

Source

seyfert/src/structures/channels.ts:97

isThreadOnly()

1
isThreadOnly(): this is MediaChannel | ForumChannel

Returns

this is MediaChannel | ForumChannel

Inherited from

BaseChannel.isThreadOnly

Source

seyfert/src/structures/channels.ts:129

isVoice()

1
isVoice(): this is VoiceChannel

Returns

this is VoiceChannel

Inherited from

BaseChannel.isVoice

Source

seyfert/src/structures/channels.ts:105

toString()

1
toString(): string

Returns

string

Inherited from

BaseChannel.toString

Source

seyfert/src/structures/channels.ts:77

intent()

intent(id)

1
static __intent__(id: "@me"): "DirectMessages"

Parameters

Parameter	Type
`id`	`"@me"`

Returns

"DirectMessages"

Inherited from

BaseChannel.__intent__

Source

seyfert/src/structures/channels.ts:51

intent(id)

1
static __intent__(id: string): "DirectMessages" | "Guilds"

Parameters

Parameter	Type
`id`	`string`

Returns

"DirectMessages" | "Guilds"

Inherited from

BaseChannel.__intent__

Source

seyfert/src/structures/channels.ts:52

allMethods()

1
static allMethods(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.client`	`UsingClient`
`ctx.guildId`	`string`

Returns

Object

Member	Type	Value
`create`	(`body`: `RESTPostAPIGuildChannelJSONBody`) => `Promise`<`AllChannels`>	-
`delete`	(`id`: `string`, `reason`?: `string`) => `Promise`<`AllChannels`>	-
`edit`	(`id`: `string`, `body`: `RESTPatchAPIChannelJSONBody`, `reason`?: `string`) => `Promise`<`AllChannels`>	-
`editPositions`	(`body`: `RESTPatchAPIGuildChannelPositionsJSONBody`) => `Promise`<`never`>	-
`fetch`	(`id`: `string`, `force`: `boolean`) => `Promise`<`AllChannels`>	-
`list`	(`force`: `boolean`) => `Promise`<`AllChannels`[]>	-

Inherited from

BaseChannel.allMethods

Source

seyfert/src/structures/channels.ts:137