Skip to main content

Message

Defined in: src/lib/messages/Message.ts:31

Extends

Extended by

Implements

Constructors

new Message()

new Message(data?): Message

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

Creates a new class instance

Parameters

data?

IBaseMessage

Returns

Message

Inherited from

BaseMessage.constructor

new Message()

new Message(client, data?): Message

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

Parameters

client

Client

data?

IBaseMessage

Returns

Message

Inherited from

BaseMessage.constructor

Properties

author?

readonly optional author: User

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

Implementation of

IMessage.author

Inherited from

BaseMessage.author


byVideoAuthor?

readonly optional byVideoAuthor: boolean

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

Raw

FeedbackSchemaBase.fromVideoAuthor

Implementation of

IMessage.byVideoAuthor

Inherited from

BaseMessage.byVideoAuthor


client?

optional client: Client

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

The client that this base was fetched with.

Inherited from

BaseMessage.client


created?

readonly optional created: Date

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

Raw

FeedbackSchemaBase.date

Implementation of

IMessage.created

Inherited from

BaseMessage.created


deleted?

readonly optional deleted: boolean

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

Raw

FeedbackSchemaBase.appearsAsDeleted

Implementation of

IMessage.deleted

Inherited from

BaseMessage.deleted


encryptedKey?

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

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

Raw

FeedbackSchemaBase.key

Implementation of

IMessage.encryptedKey

Inherited from

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

IMessage.key

Inherited from

BaseMessage.key


locked?

readonly optional locked: boolean

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

Raw

FeedbackSchemaBase.isLocked

Implementation of

IMessage.locked

Inherited from

BaseMessage.locked


pinned?

readonly optional pinned: boolean

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

Raw

FeedbackSchemaBase.isPinned

Implementation of

IMessage.pinned

Inherited from

BaseMessage.pinned


program?

readonly optional program: Program

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

Implementation of

IMessage.program

Inherited from

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

BaseMessage.rawData


replies?

readonly optional replies: Reply[]

Defined in: src/lib/messages/Message.ts:50

Implementation of

IMessage.replies


replyCount?

readonly optional replyCount: number

Defined in: src/lib/messages/Message.ts:49

Implementation of

IMessage.replyCount


score?

readonly optional score: number

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

Raw

FeedbackSchemaBase.lowQualityScore

Implementation of

IMessage.score

Inherited from

BaseMessage.score


selfDownvoted?

readonly optional selfDownvoted: boolean

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

Raw

FeedbackSchemaBase.downVoted

Implementation of

IMessage.selfDownvoted


selfFlagged?

readonly optional selfFlagged: boolean

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

Raw

FeedbackSchemaBase.flaggedByUser

Implementation of

IMessage.selfFlagged

Inherited from

BaseMessage.selfFlagged


selfUpvoted?

readonly optional selfUpvoted: boolean

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

Raw

FeedbackSchemaBase.upVoted

Implementation of

IMessage.selfUpvoted


text?

readonly optional text: string

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

Raw

FeedbackSchemaBase.content

Implementation of

IMessage.text

Inherited from

BaseMessage.text


verified?

readonly optional verified: boolean

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

Raw

FeedbackSchemaBase.definitelyNotSpam

Implementation of

IMessage.verified

Inherited from

BaseMessage.verified


votes?

readonly optional votes: number

Defined in: src/lib/messages/Message.ts:40

Raw

FeedbackSchemaBase.sumVotesIncremented

Implementation of

IMessage.votes


Type

readonly static Type: typeof MessageType = MessageType

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

Aliases for the message types.

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

Inherited from

BaseMessage.bySelf


selfVoted

Get Signature

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

Defined in: src/lib/messages/Message.ts:59

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


url

Get Signature

get url(): null | string

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

Returns

null | string

Inherited from

BaseMessage.url

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

Inherited from

BaseMessage.byUser


copy()

copy(message): Message

Defined in: src/lib/messages/Message.ts:105

Updates data into the class

Parameters

message

IMessage

Returns

Message

The class instance

Overrides

BaseMessage.copy


copyFromSchema()

copyFromSchema(schema): Message

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

Message

The class instance

Inherited from

BaseMessage.copyFromSchema


get()

get(client): Promise<Message>

Defined in: src/lib/messages/Message.ts:109

Gets and updates the instance's data

Parameters

client

Client = ...

The API client to use

Returns

Promise<Message>

Overrides

BaseMessage.get


getAllReplies()

getAllReplies(client): Promise<Message>

Defined in: src/lib/messages/Message.ts:134

Parameters

client

Client = ...

Returns

Promise<Message>

See

Client.getAllMessageReplies


getReplies()

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

Defined in: src/lib/messages/Message.ts:118

Parameters

client

Client = ...

limit?

number

Returns

AsyncGenerator<Reply[], Message, unknown>

See

Client.getMessageReplies


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

Inherited from

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

BaseMessage.isSchema


transformSchema()

transformSchema(schema): IMessage

Defined in: src/lib/messages/Message.ts:91

Transforms a API schema into an abstracted interface

Parameters

schema

RecursivePartial<BasicFeedbackSchema | QuestionFeedbackSchema | AnswerFeedbackSchema>

The schema to transform

Returns

IMessage

Overrides

BaseMessage.transformSchema


fromIdentifier()

static fromIdentifier(identifier): Message

Defined in: src/lib/messages/Message.ts:75

Parameters

identifier

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

Returns

Message


fromSchema()

static fromSchema(schema): Message

Defined in: src/lib/messages/Message.ts:64

Parameters

schema

RecursivePartial<BasicFeedbackSchema | QuestionFeedbackSchema | AnswerFeedbackSchema>

Returns

Message