Class Announcement

Represents a channel announcement.

Hierarchy (view full)

Base<string>
- Announcement

Index

Constructors

constructor

new Announcement(data, client): Announcement
Parameters
- data: {
      channelId: string;
      content: string;
      createdAt: string;
      createdBy: string;
      groupId: string;
      id: string;
      mentions?: {
          channels?: {
              id: string;
          }[];
          everyone?: boolean;
          here?: boolean;
          roles?: {
              id: number;
          }[];
          users?: {
              id: string;
          }[];
      };
      serverId: string;
      title: string;
  }
  raw data.
  - channelId: string
    Channel ID Format: uuid
    
    Description
    The ID of the channel
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the announcement
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the announcement was created at
  - createdBy: string
    Created by
    
    Description
    The ID of the user who created this announcement
  - groupId: string
    Group ID
    
    Description
    The ID of the group
  - id: string
    Announcement ID
    
    Description
    The ID of the announcement
  - Optionalmentions?: {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    }
    - Optionalchannels?: {
      id: string;
      }[]
      Channels
      
      Description
      Info on mentioned channels
    - Optionaleveryone?: boolean
      Everyone
      
      Description
      If
      
      Everyone
      was mentioned
    - Optionalhere?: boolean
      Here
      
      Description
      If
      
      Here
      was mentioned
    - Optionalroles?: {
      id: number;
      }[]
      Roles
      
      Description
      Info on mentioned roles
    - Optionalusers?: {
      id: string;
      }[]
      Users
      
      Description
      Info on mentioned users
  - serverId: string
    Server ID
    
    Description
    The ID of the server
  - title: string
    Title
    
    Description
    The title of the announcement
- client: Client
  client.
Returns Announcement
Overrides Base.constructor
- Defined in lib/structures/Announcement.ts:37

Properties

channelID

channelID: string

ID of the channel the announcement is in

client

client: Client

App's client.

comments

comments: TypedCollection<number, {
    announcementId: string;
    channelId: string;
    content: string;
    createdAt: string;
    createdBy: string;
    id: number;
    mentions?: {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    };
    updatedAt?: string;
}, AnnouncementComment, []>

Cached announcement's comments

Type declaration

announcementId: string
Announcement ID

Description
The ID of the announcement
channelId: string
Channel ID Format: uuid

Description
The ID of the channel
content: string
Content Format: long-form markdown

Description
The content of the announcement comment
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the announcement comment was created at
createdBy: string
Created by

Description
The ID of the user who created this announcement comment (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
id: number
Announcement comment ID

Description
The ID of the announcement comment
Optionalmentions?: {
    channels?: {
        id: string;
    }[];
    everyone?: boolean;
    here?: boolean;
    roles?: {
        id: number;
    }[];
    users?: {
        id: string;
    }[];
}
- Optionalchannels?: {
  id: string;
  }[]
  Channels
  
  Description
  Info on mentioned channels
- Optionaleveryone?: boolean
  Everyone
  
  Description
  If
  
  Everyone
  was mentioned
- Optionalhere?: boolean
  Here
  
  Description
  If
  
  Here
  was mentioned
- Optionalroles?: {
  id: number;
  }[]
  Roles
  
  Description
  Info on mentioned roles
- Optionalusers?: {
  id: string;
  }[]
  Users
  
  Description
  Info on mentioned users
OptionalupdatedAt?: string
Updated at Format: date-time

Description
The ISO 8601 timestamp that the announcement comment was updated at, if relevant

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 | {
    channels?: {
        id: string;
    }[];
    everyone?: boolean;
    here?: boolean;
    roles?: {
        id: number;
    }[];
    users?: {
        id: string;
    }[];
}

Mentions.

Type declaration

Optionalchannels?: {
id: string;
}[]
Channels

Description
Info on mentioned channels
Optionaleveryone?: boolean
Everyone

Description
If

Everyone
was mentioned
Optionalhere?: boolean
Here

Description
If

Here
was mentioned
Optionalroles?: {
id: number;
}[]
Roles

Description
Info on mentioned roles
Optionalusers?: {
id: string;
}[]
Users

Description
Info on mentioned users

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: {
  content: string | Record<string, never>;
  title: string;
  }
  Create options.
  - content: string | Record<string, never>
    Content
    
    Description
    The content of the announcement
  - title: string
    Title
    
    Description
    The title of the announcement
Returns Promise<Announcement>
- Defined in lib/structures/Announcement.ts:85

createReaction

createReaction(emoteID): Promise<void>
Add a reaction to this announcement.
Parameters
- emoteID: number
  ID of the emote to add
Returns Promise<void>
- Defined in lib/structures/Announcement.ts:93

delete

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

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

deleteReaction

deleteReaction(emoteID): Promise<void>
Remove a reaction from this announcement.
Parameters
- emoteID: number
  ID of the emote to remove
Returns Promise<void>
- Defined in lib/structures/Announcement.ts:113

edit

edit(options): Promise<Announcement>
Edit this announcement.
Parameters
- options: {
  content?: string | Record<string, never>;
  title?: string;
  }
  Edit options
  - Optionalcontent?: string | Record<string, never>
    Content
    
    Description
    The content of the announcement
  - Optionaltitle?: string
    Title
    
    Description
    The title of the announcement
Returns Promise<Announcement>
- Defined in lib/structures/Announcement.ts:126

toJSON

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

Class Announcement

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

channelId: string

Description

content: string

Description

createdAt: string

Description

createdBy: string

Description

groupId: string

Description

id: string

Description

Optionalmentions?: { channels?: { id: string; }[]; everyone?: boolean; here?: boolean; roles?: { id: number; }[]; users?: { id: string; }[]; }

Optionalchannels?: { id: string; }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number; }[]

Description

Optionalusers?: { id: string; }[]

Description

serverId: string

Description

title: string

Description

Returns Announcement

Properties

channelID

client

comments

Type declaration

announcementId: string

Description

channelId: string

Description

content: string

Description

createdAt: string

Description

createdBy: string

Description

id: number

Description

Optionalmentions?: { channels?: { id: string; }[]; everyone?: boolean; here?: boolean; roles?: { id: number; }[]; users?: { id: string; }[]; }

Optionalchannels?: { id: string; }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number; }[]

Description

Optionalusers?: { id: string; }[]

Description

OptionalupdatedAt?: string

Description

content

createdAt

guildID

id

memberID

mentions

Type declaration

Optionalchannels?: { id: string; }[]

Description

`Optional`mentions?: {
channels?: {
id: string;
}[];
everyone?: boolean;
here?: boolean;
roles?: {
id: number;
}[];
users?: {
id: string;
}[];
}

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`mentions?: {
channels?: {
id: string;
}[];
everyone?: boolean;
here?: boolean;
roles?: {
id: number;
}[];
users?: {
id: string;
}[];
}

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`updatedAt?: string

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`content?: string | Record<string, never>

`Optional`title?: string