logincampaigns 登录奖励

登录奖励信息获取模块。

from bestdori import logincampaigns

类型定义

LoginCampaignInfo 登录奖励信息

登录奖励信息字典。 all.{index}.json 信息字典为该字典中选取部分字段信息。

字段名	类型	描述
caption	List[str | None]	登录奖励标题定长列表
loginBonusType	str	登录奖励类型
assetBundleName	List[str | None]	资源库名称定长列表
publishedAt	List[str | None]	开始时间戳定长列表
closedAt	List[str | None]	结束时间戳定长列表
assetMap	Dict[str, Any]	资源信息字典
details	List[List[Detail] | None]	登录奖励详情定长列表

Detail 登录奖励详情

字段名	类型	描述
loginBonusId	int	登录奖励 ID
days	int	登录奖励天数
resourceType	str	登录奖励资源类型
resourceId	int	登录奖励资源 ID
quantity	int	登录奖励数量
voideId NotRequired	int	登录奖励语音 ID
seq	int	登录奖励序号
grantType	str	登录奖励类型

def get_all() async

参数名	类型	默认值	描述
index	int	0	指定获取的 JSON 信息
me keyword	Optional[Me]	None	登录用户类

获取总登录奖励信息，返回以登录奖励 ID 为字段名、 LoginCampaignsAllInfo 为字段值的信息字典， LoginCampaignsAllInfo 为从 LoginCampaignInfo 中截取出的部分信息。根据 index 参数值不同，获取到的 LoginCampaignsAllInfo 所包含的信息也不同。

特别地，当 index 值为 0 时，返回值为以登录奖励 ID 为字段名、 NoneDict 为字段值的字典

index 可用参数值

参数值	获取字段值末项字段名
0	-
1	caption
5	closedAt

返回值: Dict[str, LoginCampaignsAllInfo | NoneDict]

class LoginCampaigns()

登录奖励类，包含各种登录奖励相关资源整合。

def init()

参数名	类型	默认值	描述
id	int	-	登录奖励 ID
me keyword	Optional[Me]	None	登录用户类

def get_info() async

获取登录奖励信息。

返回值: LoginCampaignInfo

def get_comment() async

参数名	类型	默认值	描述
limit	int	20	获取到的帖子数量上限
offset	int	0	获取帖子时的偏移量
order	Order	'TIME_ASC'

获取登录奖励的社区评论列表。

返回值: PostList

def get_background() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取登录奖励背景图像资源。

返回值: bytes