AnnouncementComment represents a comment from an Announcement channel.

Hierarchy (view full)

  • Base<number>
    • AnnouncementComment

Constructors

  • Parameters

    • data: {
          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;
      }

      raw data.

      • announcementId: string

        Announcement ID

        The ID of the announcement

      • channelId: string

        Channel ID Format: uuid

        The ID of the channel

      • content: string

        Content Format: long-form markdown

        The content of the announcement comment

      • createdAt: string

        Created at Format: date-time

        The ISO 8601 timestamp that the announcement comment was created at

      • createdBy: string

        Created by

        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

        The ID of the announcement comment

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

          Channels

          Info on mentioned channels

        • Optionaleveryone?: boolean

          Everyone

          If

          was mentioned

        • Optionalhere?: boolean

          Here

          If

          was mentioned

        • Optionalroles?: {
              id: number;
          }[]

          Roles

          Info on mentioned roles

        • Optionalusers?: {
              id: string;
          }[]

          Users

          Info on mentioned users

      • OptionalupdatedAt?: string

        Updated at Format: date-time

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

    • client: Client

      client.

    • Optionaloptions: ConstructorCalendarCommentOptions

      Optional parameters that can be added

    Returns AnnouncementComment

Properties

announcementID: string

ID of the parent announcement.

channelID: string

ID of the channel where the comment is in.

client: Client

App's client.

content: string

Announcement content

createdAt: Date

The date when the comment was created.

editedTimestamp: null | Date

The date when the comment was edited, if edited.

guildID: null | string

ID of the guild, if received.

id: number

Item ID

memberID: string

ID of the member who sent this announcement.

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

Mentions

Type declaration

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

    Channels

    Info on mentioned channels

  • Optionaleveryone?: boolean

    Everyone

    If

    was mentioned

  • Optionalhere?: boolean

    Here

    If

    was mentioned

  • Optionalroles?: {
        id: number;
    }[]

    Roles

    Info on mentioned roles

  • Optionalusers?: {
        id: string;
    }[]

    Users

    Info on mentioned users

Accessors

  • get member(): undefined | Member | Promise<Member>
  • Retrieve the member who sent this comment, if cached. If there is no cached member, this will make a rest request which returns a Promise. If the request fails, it'll return undefined or throw an error that you can catch.

    Returns undefined | Member | Promise<Member>

Methods

  • Create a comment in the same announcement as this one.

    Parameters

    • options: {
          content: string;
      }

      Create options.

      • content: string

        Content Format: long-form markdown

        The content of the announcement comment

    Returns Promise<AnnouncementComment>

  • Add a reaction to this comment.

    Parameters

    • emoteID: number

      ID of the emote to add

    Returns Promise<void>

  • Delete this comment.

    Returns Promise<void>

  • Remove a reaction from this comment.

    Parameters

    • emoteID: number

      ID of the emote to remove

    Returns Promise<void>

  • Edit this comment.

    Parameters

    • options: {
          content: string;
      }

      Edit options

      • content: string

        Content Format: long-form markdown

        The content of the announcement comment

    Returns Promise<AnnouncementComment>