Class AnnouncementComment

AnnouncementComment represents a comment from an Announcement channel.

Hierarchy (view full)

Base<number>
- AnnouncementComment

Index

Constructors

constructor

new AnnouncementComment(data, client, options?): AnnouncementComment
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
    
    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
- client: Client
  client.
- Optionaloptions: ConstructorCalendarCommentOptions
  Optional parameters that can be added
Returns AnnouncementComment
Overrides Base.constructor
- Defined in lib/structures/AnnouncementComment.ts:38

Properties

announcementID

announcementID: string

ID of the parent announcement.

channelID

channelID: string

ID of the channel where the comment is in.

client

client: Client

App's client.

content

content: string

Announcement content

createdAt

createdAt: Date

The date when the comment was created.

editedTimestamp

editedTimestamp: null | Date

The date when the comment was edited, if edited.

guildID

guildID: null | string

ID of the guild, if received.

id

id: number

Item ID

memberID

memberID: string

ID of the member who sent 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

Accessors

member

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>
- Defined in lib/structures/AnnouncementComment.ts:87

Methods

createComment

createComment(options): Promise<AnnouncementComment>
Create a comment in the same announcement as this one.
Parameters
- options: {
  content: string;
  }
  Create options.
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the announcement comment
Returns Promise<AnnouncementComment>
- Defined in lib/structures/AnnouncementComment.ts:99

createReaction

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

delete

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

Returns Promise<void>
- Defined in lib/structures/AnnouncementComment.ts:124

deleteReaction

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

edit

edit(options): Promise<AnnouncementComment>
Edit this comment.
Parameters
- options: {
  content: string;
  }
  Edit options
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the announcement comment
Returns Promise<AnnouncementComment>
- Defined in lib/structures/AnnouncementComment.ts:150

toJSON

toJSON(): JSONAnnouncementComment
Returns JSONAnnouncementComment
Overrides Base.toJSON
- Defined in lib/structures/AnnouncementComment.ts:159

Class AnnouncementComment

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

Returns AnnouncementComment

Properties

announcementID

channelID

client

content

createdAt

editedTimestamp

guildID

id

memberID

mentions

Type declaration

Optionalchannels?: { id: string; }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number; }[]

Description

Optionalusers?: { id: string; }[]

Description

Accessors

member

Returns undefined | Member | Promise<Member>

Methods

createComment

Parameters

content: string

Description

Returns Promise<AnnouncementComment>

createReaction

Parameters

Returns Promise<void>

delete

Returns Promise<void>

deleteReaction

Parameters

Returns Promise<void>

edit

`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;
}[]