BaseMessage

Extends

• default<FeedbackSchemaBase, IBaseMessage>

Extended by

• Message
• Reply

Implements

• IBaseMessage

Constructors

new BaseMessage()

new BaseMessage(data?): BaseMessage

Creates a new class instance

Parameters

• data?: IBaseMessage

Returns

BaseMessage

Inherited from

Wrapper<FeedbackSchemaBase, IBaseMessage>.constructor

Source

src/lib/Wrapper.ts:36

new BaseMessage()

new BaseMessage(client, data?): BaseMessage

Parameters

• client: Client

• data?: IBaseMessage

Returns

BaseMessage

Inherited from

Wrapper<FeedbackSchemaBase, IBaseMessage>.constructor

Source

src/lib/Wrapper.ts:37

Properties

author?

optional readonly author: User

Implementation of

IBaseMessage.author

Source

src/lib/messages/BaseMessage.ts:34

---

byVideoAuthor?

optional readonly byVideoAuthor: boolean

Raw

FeedbackSchemaBase.fromVideoAuthor

Implementation of

IBaseMessage.byVideoAuthor

Source

src/lib/messages/BaseMessage.ts:74

---

client?

optional client: Client

The client that this base was fetched with.

Inherited from

Wrapper.client

Source

src/lib/Wrapper.ts:15

---

created?

optional readonly created: Date

Raw

FeedbackSchemaBase.date

Implementation of

IBaseMessage.created

Source

src/lib/messages/BaseMessage.ts:39

---

deleted?

optional readonly deleted: boolean

Raw

FeedbackSchemaBase.appearsAsDeleted

Implementation of

IBaseMessage.deleted

Source

src/lib/messages/BaseMessage.ts:53

---

encryptedKey?

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

Raw

FeedbackSchemaBase.key

Implementation of

IBaseMessage.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

IBaseMessage.key

Source

src/lib/messages/BaseMessage.ts:44

---

locked?

optional readonly locked: boolean

Raw

FeedbackSchemaBase.isLocked

Implementation of

IBaseMessage.locked

Source

src/lib/messages/BaseMessage.ts:57

---

pinned?

optional readonly pinned: boolean

Raw

FeedbackSchemaBase.isPinned

Implementation of

IBaseMessage.pinned

Source

src/lib/messages/BaseMessage.ts:61

---

program?

optional readonly program: Program

Implementation of

IBaseMessage.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

Wrapper.rawData

Source

src/lib/Wrapper.ts:22

---

score?

optional readonly score: number

Raw

FeedbackSchemaBase.lowQualityScore

Implementation of

IBaseMessage.score

Source

src/lib/messages/BaseMessage.ts:69

---

selfFlagged?

optional readonly selfFlagged: boolean

Raw

FeedbackSchemaBase.flaggedByUser

Implementation of

IBaseMessage.selfFlagged

Source

src/lib/messages/BaseMessage.ts:79

---

text?

optional readonly text: string

Raw

FeedbackSchemaBase.content

Implementation of

IBaseMessage.text

Source

src/lib/messages/BaseMessage.ts:33

---

verified?

optional readonly verified: boolean

Raw

FeedbackSchemaBase.definitelyNotSpam

Implementation of

IBaseMessage.verified

Source

src/lib/messages/BaseMessage.ts:65

Accessors

bySelf

get bySelf(): boolean

Checks if the message was written by the client user

Returns

boolean

Source

src/lib/messages/BaseMessage.ts:84

---

url

get url(): null | string

Returns

null | string

Source

src/lib/messages/BaseMessage.ts:88

Methods

byUser()

byUser(user): boolean

Checks if the message was written by the given user

Parameters

• user: User

Returns

boolean

Source

src/lib/messages/BaseMessage.ts:138

---

copy()

copy(data): BaseMessage

Updates data into the class

Parameters

• data: IBaseMessage

The data to copy from

Returns

BaseMessage

The class instance

Inherited from

Wrapper.copy

Source

src/lib/Wrapper.ts:53

---

copyFromSchema()

copyFromSchema(schema): BaseMessage

Updates data from a schema into the instance

Parameters

• schema: RecursivePartial<FeedbackSchemaBase>

The schema to copy from

Returns

BaseMessage

The class instance

Inherited from

Wrapper.copyFromSchema

Source

src/lib/Wrapper.ts:65

---

get()

abstract get(client?): Promise<BaseMessage>

Gets and updates the instance's data

Parameters

• client?: Client

The API client to use

Returns

Promise<BaseMessage>

Inherited from

Wrapper.get

Source

src/lib/Wrapper.ts:78

---

is()

is(message): boolean

Checks if the message is the same as the given message

Parameters

• message: IBaseMessage | BaseMessage

Returns

boolean

Overrides

Wrapper.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

Wrapper.isSchema

Source

src/lib/Wrapper.ts:88

---

transformSchema()

transformSchema(schema): IBaseMessage

Parameters

• schema: RecursivePartial<FeedbackSchemaBase>

Returns

IBaseMessage

Overrides

Wrapper.transformSchema

Source

src/lib/messages/BaseMessage.ts:101