cyan.model.schedule module

class cyan.model.schedule.RemindType(value)

基类：enum.Enum

提醒类型。

EARLIER = 5

较早提醒（开始前 60 分钟提醒）。

EARLY = 4

早期提醒（开始前 30 分钟提醒）。

INSTANT = 1

开始时提醒。

LATE = 3

晚期提醒（开始前 15 分钟提醒）。

LATER = 2

较晚提醒（开始前 5 分钟提醒）。

SILENT = 0

不提醒。

class cyan.model.schedule.Schedule(bot: cyan.bot.Bot, channel: ScheduleChannel, props: Dict[str, Any])

基类：cyan.model.Model, cyan.model.renovatable.AsyncRenovatable[Schedule]

日程。

property bot: cyan.bot.Bot

Model 所属机器人。

async cancel() → None

异步取消当前日程。

property channel: ScheduleChannel

日程所属子频道。

property creator: cyan.model.user.User

日程创建者。

property description: str

日程描述。

property end_time: datetime.datetime

日程结束时间。

async get_destination() → Optional[Channel]

异步获取日程指向的目标子频道。

返回：

当存在目标子频道时，返回以 Channel 类型表示的子频道；若不存在，则返回 None。

property identifier: str

Model ID。

property name: str

日程名称。

property remind_type: cyan.model.schedule.RemindType

日程提醒类型。

async renovate() → cyan.model.schedule.Schedule

获取更新的实例。

async set_description(description: str) → None

异步修改日程描述。

参数：

• description: 目标描述

async set_destination(channel: Channel) → None

异步修改日程指向的目标子频道。

参数：

• channel: 目标子频道

async set_end_time(time: datetime.datetime) → None

异步修改日程结束时间。

参数：

• time: 目标结束时间

async set_name(name: str) → None

异步修改日程名称。

参数：

• name: 目标名称

async set_remind_type(remind_type: cyan.model.schedule.RemindType) → None

异步修改日程提醒类型。

参数：

• remind_type: 目标提醒类型

async set_start_time(time: datetime.datetime) → None

异步修改日程开始时间。

参数：

• time: 目标开始时间

property start_time: datetime.datetime

日程开始时间。

async unset_destination() → None

异步取消日程指向目标子频道。