BaseSession | kbotify

Hierarchy

BaseObject
- BaseSession
  - GuildSession
  - PrivateSession

Implements

BaseData

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BaseSession(command: AppCommand | MenuCommand, args: string[], msg: TextMessage | ButtonEventMessage, client?: KBotify): BaseSession

Overrides BaseObject.constructor
- Defined in src/core/session/session.base.ts:39
Parameters
- command: AppCommand | MenuCommand
- args: string[]
- msg: TextMessage | ButtonEventMessage
- Optional client: KBotify
Returns BaseSession

Properties

args

args: string[]

channel

channel: Channel

client

client: KBotify

Optional cmdString

cmdString: string

命令字符串

command

command: AppCommand | MenuCommand

content

content: undefined | string

Optional guild

guild: Guild

mention

mention: SessionSendFunc = ...

mentionTemp

mentionTemp: SessionSendFunc = ...

msg

msg: TextMessage | ButtonEventMessage

Optional other

other: any

quote

quote: SessionSendFunc = ...

Send message with quotation (no @ included)

quoteTemp

quoteTemp: SessionSendFunc = ...

Send temporary message with quotation (no @ included)

reply

reply: SessionSendFunc = ...

replyTemp

replyTemp: SessionSendFunc = ...

send

send: SessionSendFunc = ...

sendTemp

sendTemp: SessionSendFunc = ...

user

user: BaseUser

userId

userId: string

会话的用户ID。如果是文字消息，则返回发送者ID，如果是按钮事件，则返回点击者ID。

memberof: BaseSession

Accessors

_botInstance

get _botInstance(): KBotify

- Defined in src/core/base/bot.object.ts:16
deprecated

readonly

memberof

BaseObject

Returns KBotify

guildId

get guildId(): undefined | string

- Defined in src/core/session/session.base.ts:69
Returns undefined | string

Methods

_send

_send(content: string | (() => string) | (() => Promise<string>), resultType?: ResultTypes, sendOptions?: SendOptions): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:317
发送消息。

接收

如果接收的消息为文字消息，则可以使用引用和@。如果接收的消息为按钮点击事件消息，则可以使用@。

发送

如果发送的消息为文字或kmarkdown，则可以使用引用和@。如果发送的消息为卡片消息，则可以使用引用。

memberof

BaseSession

Parameters
- content: string | (() => string) | (() => Promise<string>)
- resultType: ResultTypes = ...
- Optional sendOptions: SendOptions
Returns Promise<FuncResult<any>>

Private Readonly _sendCard

_sendCard(content: string | CardObject[] | Card | (() => string) | (() => Promise<string>), options?: SendOptions): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:373
Parameters
- content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)
- options: SendOptions = ...
Returns Promise<FuncResult<any>>

getBotInstance

getBotInstance(): KBotify

Inherited from BaseObject.getBotInstance
- Defined in src/core/base/bot.object.ts:20
Returns KBotify

replyCard

replyCard(content: string | (() => string) | (() => Promise<string>) | CardObject[] | Card, options?: Omit<SendOptions, "reply">): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:95
Parameters
- content: string | (() => string) | (() => Promise<string>) | CardObject[] | Card
- Optional options: Omit<SendOptions, "reply">
Returns Promise<FuncResult<any>>

replyCardTemp

replyCardTemp(content: string | CardObject[] | Card | (() => string) | (() => Promise<string>), options?: Omit<SendOptions, "reply" | "temp">): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:107
Parameters
- content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)
- Optional options: Omit<SendOptions, "reply" | "temp">
Returns Promise<FuncResult<any>>

sendCard

sendCard(content: string | CardObject[] | Card | (() => string) | (() => Promise<string>), options?: SendOptions): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:191
Parameters
- content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)
- Optional options: SendOptions
Returns Promise<FuncResult<any>>

sendCardTemp

sendCardTemp(content: string | CardObject[] | Card | (() => string) | (() => Promise<string>), options?: Omit<SendOptions, "temp">): Promise<FuncResult<any>>

- Defined in src/core/session/session.base.ts:203
Parameters
- content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)
- Optional options: Omit<SendOptions, "temp">
Returns Promise<FuncResult<any>>

setTextTrigger

setTextTrigger(condition: string | RegExp, timeout?: null | number, callback: (msg: TextMessage) => void): () => void

- Defined in src/core/session/session.base.ts:270
设置文字回复触发事件

Parameters
- condition: string | RegExp
  
  文字满足的要求，包含的文字或正则表达式
- timeout: null | number = 6e4
  
  单位：ms 回复触发有效时间，默认为1分钟
- callback: (msg: TextMessage) => void
  
  触发后的回调函数
  - - (msg: TextMessage): void
    - Parameters
      - msg: TextMessage
      Returns void
Returns () => void
- - (): void
  - Returns void

updateMessage

updateMessage(messageId: string, content: string | CardObject[], quote?: string, tempTargetId?: string): Promise<FuncResult<boolean>>

- Defined in src/core/session/session.base.ts:221
Parameters
- messageId: string
- content: string | CardObject[]
- Optional quote: string
- Optional tempTargetId: string
Returns Promise<FuncResult<boolean>>

updateMessageTemp

updateMessageTemp(messageId: string, content: string | CardObject[], quote?: string): Promise<FuncResult<boolean>>

- Defined in src/core/session/session.base.ts:249
Parameters
- messageId: string
- content: string | CardObject[]
- Optional quote: string
Returns Promise<FuncResult<boolean>>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

command: AppCommand | MenuCommand

args: string[]

msg: TextMessage | ButtonEventMessage

Optional client: KBotify

Returns BaseSession

Properties

args

channel

client

Optional cmdString

command

content

Optional guild

mention

mentionTemp

msg

Optional other

quote

quoteTemp

reply

replyTemp

send

sendTemp

user

userId

Accessors

_botInstance

Returns KBotify

guildId

Returns undefined | string

Methods

_send

接收

发送

Parameters

content: string | (() => string) | (() => Promise<string>)

resultType: ResultTypes = ...

Optional sendOptions: SendOptions

Returns Promise<FuncResult<any>>

Private Readonly _sendCard

Parameters

content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)

options: SendOptions = ...

Returns Promise<FuncResult<any>>

getBotInstance

Returns KBotify

replyCard

Parameters

content: string | (() => string) | (() => Promise<string>) | CardObject[] | Card

Optional options: Omit<SendOptions, "reply">

Returns Promise<FuncResult<any>>

replyCardTemp

Parameters

content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)

Optional options: Omit<SendOptions, "reply" | "temp">

Returns Promise<FuncResult<any>>

sendCard

Parameters

content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)

Optional options: SendOptions

Returns Promise<FuncResult<any>>

sendCardTemp

Parameters

content: string | CardObject[] | Card | (() => string) | (() => Promise<string>)

Optional options: Omit<SendOptions, "temp">

Returns Promise<FuncResult<any>>

setTextTrigger

Parameters

condition: string | RegExp

timeout: null | number = 6e4