# Interface: CreateRedEnvelopeShareIdParams
• CreateRedEnvelopeShareIdParams()
# Properties
# Readonly activityId
• activityId: number
红包活动 ID
Returns: number
# Optional Readonly count
• count? : number
红包数量
description 仅红包种类为 RedEnvelopeCountType.Variable 时可用,可指定一个红包数量;若指定的值大于红包配置的最大数量,则以配置的最大数量为准。
Returns: number
# Methods
# Optional complete
▸ complete(this: void, res: CreateRedEnvelopeShareIdRes | MogsError): void
Inherited from GetUserSignParams.complete
操作完成时(成功或失败),均会调用该回调函数
# 参数:
| 属性 | 类型 |
|---|---|
this | void |
res | CreateRedEnvelopeShareIdRes | MogsError |
# 返回值:
void
# Optional fail
▸ fail(this: void, error: MogsError): void
Inherited from GetUserSignParams.fail
操作失败时,调用该回调函数
# 参数:
| 属性 | 类型 |
|---|---|
this | void |
error | MogsError |
# 返回值:
void
# Optional success
▸ success(this: void, res: CreateRedEnvelopeShareIdRes): void
Inherited from GetUserSignParams.success
操作成功时,调用该回调函数
# 参数:
| 属性 | 类型 |
|---|---|
this | void |
res | CreateRedEnvelopeShareIdRes |
CreateRedEnvelopeShareIdRes
| 属性 | 类型 | 描述 |
|---|---|---|
eventList? | keyof MogsEvent | 当前 Action 所触发的所有事件的列表 |
shareId | Long | 红包分享 ID |
# 返回值:
void