Class Announcement

Represents a channel announcement.

Hierarchy

Base<string>
- Announcement

Index

Constructors

constructor

new Announcement(data, client): Announcement
Parameters
- data: APIAnnouncement
  
  raw data.
- client: Client
  
  client.
Returns Announcement
Overrides Base.constructor
- Defined in lib/structures/Announcement.ts:38

Properties

channelID

channelID: string

ID of the channel the announcement is in

client

client: Client

Bot's client.

comments

comments: TypedCollection<number, APIAnnouncementComment, AnnouncementComment, []>

Cached announcement's comments

content

content: string

The announcement's content

createdAt

createdAt: Date

The ISO 8601 timestamp that the announcement was created at

guildID

guildID: string

ID of the guild.

id

id: string

Item ID

memberID

memberID: string

The ID of the member who created this announcement

mentions

mentions: null | APIMentions

Mentions.

title

title: string

The announcement's title.

Methods

createAnnouncement

createAnnouncement(options): Promise<Announcement>
Create an announcement in the same Announcement channel as this one.
Parameters
- options: POSTChannelAnnouncementBody
  
  Create options.
Returns Promise<Announcement>
- Defined in lib/structures/Announcement.ts:110

createReaction

createReaction(emoteID): Promise<void>
Add a reaction to this announcement.
Parameters
- emoteID: number
Returns Promise<void>
- Defined in lib/structures/Announcement.ts:118

delete

delete(): Promise<void>
Delete this announcement.

Returns Promise<void>
- Defined in lib/structures/Announcement.ts:102

deleteReaction

deleteReaction(emoteID): Promise<void>
Remove a reaction from this announcement.
Parameters
- emoteID: number
Returns Promise<void>
- Defined in lib/structures/Announcement.ts:126

edit

edit(options): Promise<Announcement>
Edit this announcement.
Parameters
- options: PATCHChannelAnnouncementBody
  
  Edit options
Returns Promise<Announcement>
- Defined in lib/structures/Announcement.ts:95

toJSON

toJSON(): JSONAnnouncement
Returns JSONAnnouncement
Overrides Base.toJSON
- Defined in lib/structures/Announcement.ts:51

Class Announcement

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: APIAnnouncement

client: Client

Returns Announcement

Properties

channelID

client

comments

content

createdAt

guildID

id

memberID

mentions

title

Methods

createAnnouncement

Parameters

options: POSTChannelAnnouncementBody

Returns Promise<Announcement>

createReaction

Parameters

emoteID: number

Returns Promise<void>

delete

Returns Promise<void>

deleteReaction

Parameters

emoteID: number

Returns Promise<void>

edit

Parameters

options: PATCHChannelAnnouncementBody

Returns Promise<Announcement>

toJSON

Returns JSONAnnouncement

Settings

Member Visibility

Theme

On This Page