Class Announcement

Represents a channel announcement.

Hierarchy (View Summary)

  • Base<string>
    • Announcement

Constructors

constructor

Properties

channelID client comments content createdAt guildID id memberID mentions title

Methods

createAnnouncement createReaction delete deleteReaction edit toJSON

Constructors

constructor

  • new Announcement(
        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;
        },
        client: 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

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

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

  • null
  • {
        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

title

title: string

The announcement's title.

Methods

createAnnouncement

  • createAnnouncement(
        options: { content: string | Record<string, never>; title: string },
    ): 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>

createReaction

  • createReaction(emoteID: number): Promise<void>

    Add a reaction to this announcement.

    Parameters

    • emoteID: number

      ID of the emote to add

    Returns Promise<void>

delete

deleteReaction

  • deleteReaction(emoteID: number): Promise<void>

    Remove a reaction from this announcement.

    Parameters

    • emoteID: number

      ID of the emote to remove

    Returns Promise<void>

edit

  • edit(
        options: { content?: string | Record<string, never>; title?: string },
    ): 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>

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Methods