# Class: SharedRedEnvelope

SharedRedEnvelope()

已分享的红包状态信息

# Accessors

# endTime

get endTime(): Date

(所属红包活动)当前周期结束时间

description 举例来说,如果有一个红包活动配置为每天重置,活动开始时间为某一天的 23 点,则用户在 21 点分享的红包,该属性会是当天的 23 点;若该用户在 23:30 分享的该红包,则该属性为第二天的 23 点。

description 注意:到期后,该红包信息会被移除,但已经分享出去的红包在有效期内仍可以被其他玩家领取。

# 返回值:

Date


# redEnvelope

get redEnvelope(): RedEnvelope

对应的红包信息

# 返回值:

RedEnvelope


# shareId

get shareId(): string

红包分享 ID

# 返回值:

string

# 操作触发

# getStatus

getStatus(params?: Omit‹GetSharedRedEnvelopeStatusParams, "shareId" | "fromOpenId"›): Promise‹GetSharedRedEnvelopeStatusRes

查看当前(自已分享的)红包状态

# 参数:

属性 类型
params? Omit‹GetSharedRedEnvelopeStatusParams, "shareId" | "fromOpenId"›

# 返回值:

Promise‹GetSharedRedEnvelopeStatusRes


# receive

receive(params?: Omit‹ReceiveRedEnvelopeParams, "shareId" | "fromOpenId"›): Promise‹ReceiveRedEnvelopeRes

领取当前(自己分享的)红包

# 参数:

属性 类型
params? Omit‹ReceiveRedEnvelopeParams, "shareId" | "fromOpenId"›

# 返回值:

Promise‹ReceiveRedEnvelopeRes