xyz.cssxsh.mirai.spi.TimerService.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mirai-administrator Show documentation

mirai-administrator

The newest version!

package xyz.cssxsh.mirai.spi

import kotlinx.coroutines.*
import net.mamoe.mirai.contact.*

/**
 * 定时的服务, [run] 返回消息
 * @see BotTimingMessage
 * @see GroupTimerService
 */
public sealed interface TimerService : ComparableService {
    /**
     * 已经开始运行的标记
     */
    public val records: MutableMap

    /**
     * 运行的时间，为 null 时停止定时器
     * @return 等待执行的时间，为 null 时停止定时器
     */
    public fun wait(contact: C): Long?

    /**
     * 运行定时器
     */
    public suspend fun run(contact: C): R
}