BaseMessage

Defined in: src/lib/messages/BaseMessage.ts:26

Extends

• default<FeedbackSchemaBase, IBaseMessage>

Extended by

• Message
• Reply

Implements

• IBaseMessage

Constructors

new BaseMessage()

new BaseMessage(data?): BaseMessage

Defined in: src/lib/Wrapper.ts:36

Creates a new class instance

Parameters

data?

IBaseMessage

Returns

BaseMessage

Inherited from

Wrapper<FeedbackSchemaBase, IBaseMessage>.constructor

new BaseMessage()

new BaseMessage(client, data?): BaseMessage

Defined in: src/lib/Wrapper.ts:37

Parameters

client

Client

data?

IBaseMessage

Returns

BaseMessage

Inherited from

Wrapper<FeedbackSchemaBase, IBaseMessage>.constructor

Properties

author?

readonly optional author: User

Defined in: src/lib/messages/BaseMessage.ts:34

Implementation of

IBaseMessage.author

---

byVideoAuthor?

readonly optional byVideoAuthor: boolean

Defined in: src/lib/messages/BaseMessage.ts:74

Raw

FeedbackSchemaBase.fromVideoAuthor

Implementation of

IBaseMessage.byVideoAuthor

---

client?

optional client: Client

Defined in: src/lib/Wrapper.ts:15

The client that this base was fetched with.

Inherited from

Wrapper.client

---

created?

readonly optional created: Date

Defined in: src/lib/messages/BaseMessage.ts:39

Raw

FeedbackSchemaBase.date

Implementation of

IBaseMessage.created

---

deleted?

readonly optional deleted: boolean

Defined in: src/lib/messages/BaseMessage.ts:53

Raw

FeedbackSchemaBase.appearsAsDeleted

Implementation of

IBaseMessage.deleted

---

encryptedKey?

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

Defined in: src/lib/messages/BaseMessage.ts:48

Raw

FeedbackSchemaBase.key

Implementation of

IBaseMessage.encryptedKey

---

key?

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

Defined in: src/lib/messages/BaseMessage.ts:44

Raw

FeedbackSchemaBase.expandKey

Implementation of

IBaseMessage.key

---

locked?

readonly optional locked: boolean

Defined in: src/lib/messages/BaseMessage.ts:57

Raw

FeedbackSchemaBase.isLocked

Implementation of

IBaseMessage.locked

---

pinned?

readonly optional pinned: boolean

Defined in: src/lib/messages/BaseMessage.ts:61

Raw

FeedbackSchemaBase.isPinned

Implementation of

IBaseMessage.pinned

---

program?

readonly optional program: Program

Defined in: src/lib/messages/BaseMessage.ts:35

Implementation of

IBaseMessage.program

---

rawData?

optional rawData: RecursivePartial<FeedbackSchemaBase>

Defined in: src/lib/Wrapper.ts:22

The raw base schema data

Remarks

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

Inherited from

Wrapper.rawData

---

score?

readonly optional score: number

Defined in: src/lib/messages/BaseMessage.ts:69

Raw

FeedbackSchemaBase.lowQualityScore

Implementation of

IBaseMessage.score

---

selfFlagged?

readonly optional selfFlagged: boolean

Defined in: src/lib/messages/BaseMessage.ts:79

Raw

FeedbackSchemaBase.flaggedByUser

Implementation of

IBaseMessage.selfFlagged

---

text?

readonly optional text: string

Defined in: src/lib/messages/BaseMessage.ts:33

Raw

FeedbackSchemaBase.content

Implementation of

IBaseMessage.text

---

verified?

readonly optional verified: boolean

Defined in: src/lib/messages/BaseMessage.ts:65

Raw

FeedbackSchemaBase.definitelyNotSpam

Implementation of

IBaseMessage.verified

Accessors

bySelf

Get Signature

get bySelf(): boolean

Defined in: src/lib/messages/BaseMessage.ts:84

Checks if the message was written by the client user

Returns

boolean

---

url

Get Signature

get url(): null | string

Defined in: src/lib/messages/BaseMessage.ts:88

Returns

null | string

Methods

byUser()

byUser(user): boolean

Defined in: src/lib/messages/BaseMessage.ts:138

Checks if the message was written by the given user

Parameters

user

User

Returns

boolean

---

copy()

copy(data): BaseMessage

Defined in: src/lib/Wrapper.ts:53

Updates data into the class

Parameters

data

IBaseMessage

The data to copy from

Returns

BaseMessage

The class instance

Inherited from

Wrapper.copy

---

copyFromSchema()

copyFromSchema(schema): BaseMessage

Defined in: src/lib/Wrapper.ts:65

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

---

get()

abstract get(client?): Promise<BaseMessage>

Defined in: src/lib/Wrapper.ts:78

Gets and updates the instance's data

Parameters

client?

Client

The API client to use

Returns

Promise<BaseMessage>

Inherited from

Wrapper.get

---

is()

is(message): boolean

Defined in: src/lib/messages/BaseMessage.ts:145

Checks if the message is the same as the given message

Parameters

message

IBaseMessage | BaseMessage

Returns

boolean

Overrides

Wrapper.is

---

isSchema()

isSchema(schema): boolean

Defined in: src/lib/Wrapper.ts:88

Checks if the schema represents the same instance

Parameters

schema

RecursivePartial<FeedbackSchemaBase>

Returns

boolean

Inherited from

Wrapper.isSchema

---

transformSchema()

transformSchema(schema): IBaseMessage

Defined in: src/lib/messages/BaseMessage.ts:101

Transforms a API schema into an abstracted interface

Parameters

schema

RecursivePartial<FeedbackSchemaBase>

The schema to transform

Returns

IBaseMessage

Overrides

Wrapper.transformSchema