Message

Extends

• BaseMessage

Extended by

• TipsAndThanks
• Question
• Answer

Implements

• IMessage

Constructors

new Message()

new Message(data?): Message

Creates a new class instance

Parameters

• data?: IBaseMessage

Returns

Message

Inherited from

BaseMessage.constructor

Source

src/lib/Wrapper.ts:36

new Message()

new Message(client, data?): Message

Parameters

• client: Client

• data?: IBaseMessage

Returns

Message

Inherited from

BaseMessage.constructor

Source

src/lib/Wrapper.ts:37

Properties

author?

optional readonly author: User

Implementation of

IMessage.author

Inherited from

BaseMessage.author

Source

src/lib/messages/BaseMessage.ts:34

---

byVideoAuthor?

optional readonly byVideoAuthor: boolean

Raw

FeedbackSchemaBase.fromVideoAuthor

Implementation of

IMessage.byVideoAuthor

Inherited from

BaseMessage.byVideoAuthor

Source

src/lib/messages/BaseMessage.ts:74

---

client?

optional client: Client

The client that this base was fetched with.

Inherited from

BaseMessage.client

Source

src/lib/Wrapper.ts:15

---

created?

optional readonly created: Date

Raw

FeedbackSchemaBase.date

Implementation of

IMessage.created

Inherited from

BaseMessage.created

Source

src/lib/messages/BaseMessage.ts:39

---

deleted?

optional readonly deleted: boolean

Raw

FeedbackSchemaBase.appearsAsDeleted

Implementation of

IMessage.deleted

Inherited from

BaseMessage.deleted

Source

src/lib/messages/BaseMessage.ts:53

---

encryptedKey?

optional readonly encryptedKey: `kaencrypted_${string}_${string}`

Raw

FeedbackSchemaBase.key

Implementation of

IMessage.encryptedKey

Inherited from

BaseMessage.encryptedKey

Source

src/lib/messages/BaseMessage.ts:48

---

key?

optional readonly key: `ag5zfmtoYW4tYWNhZGVteX${string}CxIIVXNlckRhdGEi${string}thaWRf${string}${string}${string}`

Raw

FeedbackSchemaBase.expandKey

Implementation of

IMessage.key

Inherited from

BaseMessage.key

Source

src/lib/messages/BaseMessage.ts:44

---

locked?

optional readonly locked: boolean

Raw

FeedbackSchemaBase.isLocked

Implementation of

IMessage.locked

Inherited from

BaseMessage.locked

Source

src/lib/messages/BaseMessage.ts:57

---

pinned?

optional readonly pinned: boolean

Raw

FeedbackSchemaBase.isPinned

Implementation of

IMessage.pinned

Inherited from

BaseMessage.pinned

Source

src/lib/messages/BaseMessage.ts:61

---

program?

optional readonly program: Program

Implementation of

IMessage.program

Inherited from

BaseMessage.program

Source

src/lib/messages/BaseMessage.ts:35

---

rawData?

optional rawData: RecursivePartial<FeedbackSchemaBase>

The raw base schema data

Remarks

Only set if the base was created from a user schema.

Inherited from

BaseMessage.rawData

Source

src/lib/Wrapper.ts:22

---

replies?

optional readonly replies: Reply[]

Implementation of

IMessage.replies

Source

src/lib/messages/Message.ts:50

---

replyCount?

optional readonly replyCount: number

Implementation of

IMessage.replyCount

Source

src/lib/messages/Message.ts:49

---

score?

optional readonly score: number

Raw

FeedbackSchemaBase.lowQualityScore

Implementation of

IMessage.score

Inherited from

BaseMessage.score

Source

src/lib/messages/BaseMessage.ts:69

---

selfDownvoted?

optional readonly selfDownvoted: boolean

Raw

FeedbackSchemaBase.downVoted

Implementation of

IMessage.selfDownvoted

Source

src/lib/messages/Message.ts:48

---

selfFlagged?

optional readonly selfFlagged: boolean

Raw

FeedbackSchemaBase.flaggedByUser

Implementation of

IMessage.selfFlagged

Inherited from

BaseMessage.selfFlagged

Source

src/lib/messages/BaseMessage.ts:79

---

selfUpvoted?

optional readonly selfUpvoted: boolean

Raw

FeedbackSchemaBase.upVoted

Implementation of

IMessage.selfUpvoted

Source

src/lib/messages/Message.ts:44

---

text?

optional readonly text: string

Raw

FeedbackSchemaBase.content

Implementation of

IMessage.text

Inherited from

BaseMessage.text

Source

src/lib/messages/BaseMessage.ts:33

---

verified?

optional readonly verified: boolean

Raw

FeedbackSchemaBase.definitelyNotSpam

Implementation of

IMessage.verified

Inherited from

BaseMessage.verified

Source

src/lib/messages/BaseMessage.ts:65

---

votes?

optional readonly votes: number

Raw

FeedbackSchemaBase.sumVotesIncremented

Implementation of

IMessage.votes

Source

src/lib/messages/Message.ts:40

---

Type

static readonly Type: typeof MessageType = MessageType

Aliases for the message types.

Source

src/lib/messages/Message.ts:35

Accessors

bySelf

get bySelf(): boolean

Checks if the message was written by the client user

Returns

boolean

Source

src/lib/messages/BaseMessage.ts:84

---

selfVoted

get selfVoted(): null | 1 | 0 | -1

See

• Message.selfUpvoted
• Message.selfDownvoted

Returns

null | 1 | 0 | -1

1 if the message was upvoted by the user, -1 if it was downvoted, and 0 if it was not voted on. null if the user is not logged in.

Source

src/lib/messages/Message.ts:59

---

url

get url(): null | string

Returns

null | string

Source

src/lib/messages/BaseMessage.ts:88

Methods

#resolveIdentifier()

private #resolveIdentifier(): `ag5zfmtoYW4tYWNhZGVteX${string}CxIIVXNlckRhdGEi${string}thaWRf${string}${string}${string}` | `kaencrypted_${string}_${string}`

Returns

`ag5zfmtoYW4tYWNhZGVteX${string}CxIIVXNlckRhdGEi${string}thaWRf${string}${string}${string}` | `kaencrypted_${string}_${string}`

Source

src/lib/messages/Message.ts:84

---

byUser()

byUser(user): boolean

Checks if the message was written by the given user

Parameters

• user: User

Returns

boolean

Inherited from

BaseMessage.byUser

Source

src/lib/messages/BaseMessage.ts:138

---

copy()

copy(message): Message

Updates data into the class

Parameters

• message: IMessage

The data to copy from

Returns

Message

The class instance

Overrides

BaseMessage.copy

Source

src/lib/messages/Message.ts:105

---

copyFromSchema()

copyFromSchema(schema): Message

Updates data from a schema into the instance

Parameters

• schema: RecursivePartial<FeedbackSchemaBase>

The schema to copy from

Returns

Message

The class instance

Inherited from

BaseMessage.copyFromSchema

Source

src/lib/Wrapper.ts:65

---

get()

get(client): Promise<Message>

Gets and updates the instance's data

Parameters

• client: Client= undefined

The API client to use

Returns

Promise<Message>

Overrides

BaseMessage.get

Source

src/lib/messages/Message.ts:109

---

getAllReplies()

getAllReplies(client): Promise<Message>

Parameters

• client: Client= undefined

Returns

Promise<Message>

See

Client.getAllMessageReplies

Source

src/lib/messages/Message.ts:134

---

getReplies()

getReplies(client, limit?): AsyncGenerator<Reply[], Message, unknown>

Parameters

• client: Client= undefined

• limit?: number

Returns

AsyncGenerator<Reply[], Message, unknown>

See

Client.getMessageReplies

Source

src/lib/messages/Message.ts:118

---

is()

is(message): boolean

Checks if the message is the same as the given message

Parameters

• message: IBaseMessage | BaseMessage

Returns

boolean

Inherited from

BaseMessage.is

Source

src/lib/messages/BaseMessage.ts:145

---

isSchema()

isSchema(schema): boolean

Checks if the schema represents the same instance

Parameters

• schema: RecursivePartial<FeedbackSchemaBase>

Returns

boolean

Inherited from

BaseMessage.isSchema

Source

src/lib/Wrapper.ts:88

---

transformSchema()

transformSchema(schema): IMessage

Parameters

• schema: RecursivePartial<BasicFeedbackSchema | QuestionFeedbackSchema | AnswerFeedbackSchema>

Returns

IMessage

Overrides

BaseMessage.transformSchema

Source

src/lib/messages/Message.ts:91

---

fromIdentifier()

static fromIdentifier(identifier): Message

Parameters

• identifier: `ag5zfmtoYW4tYWNhZGVteX${string}CxIIVXNlckRhdGEi${string}thaWRf${string}${string}${string}` | `kaencrypted_${string}_${string}`

Returns

Message

Source

src/lib/messages/Message.ts:75

---

fromSchema()

static fromSchema(schema): Message

Parameters

• schema: RecursivePartial<BasicFeedbackSchema | QuestionFeedbackSchema | AnswerFeedbackSchema>

Returns

Message

Source

src/lib/messages/Message.ts:64