# Class: RedEnvelope
• RedEnvelope()
红包信息
# Accessors
# countType
• get countType(): RedEnvelopeCountType
红包数量类型
description 当且仅当此属性为 RedEnvelopeCountType.Variable 时，可以在发红包的时候指定红包数量。
# 返回值:
# customStr
• get customStr(): string | undefined
自定义字符串
description 可用于配置游戏侧自定义的抽奖奖励。
# 返回值:
string | undefined
# maxCount
• get maxCount(): number
(最大)红包数量
description 若为固定数量 RedEnvelopeCountType.Immutable 红包，则每次发红包的数量均为该值；否则，每次发红包的数量由该值和传入的数量参数共同决定。
# 返回值:
number
# rewardPool
• get rewardPool(): RewardPool | undefined
红包对应奖励池
description 若游戏侧使用了自定义的抽奖奖励，则该属性为空。
# 返回值:
RewardPool | undefined
# totalAmount
• get totalAmount(): number
奖励总数量
description 指单次分享红包中，所有领取红包的人能领取到的红包奖励的物品、属性或游戏自定义数据的总量。
# 返回值:
number
# validTime
• get validTime(): number
红包有效时长
description 单位为秒。
# 返回值:
number
# Methods
# getMaxReceivedAmount
▸ getMaxReceivedAmount(count?: number): number
查看单次抽奖最大值
description 由游戏侧配置的参数计算而来，最大值为 totalAmount - (maxCount - 1)。
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
count? | number | 要发出的红包数量；若红包种类为数量不可变类型 RedEnvelopeCountType.Immutable，则该参数会被忽略。 |
# 返回值:
number
# getMinReceivedAmount
▸ getMinReceivedAmount(count?: number): number
查看单次抽奖最小值
description 由游戏侧配置的参数计算而来，最小值为 1。
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
count? | number | 要发出的红包数量；若红包种类为数量不可变类型 RedEnvelopeCountType.Immutable，则该参数会被忽略。 |
# 返回值:
number