# Interface: ShareAppMessageParams ‹Err›
• ShareAppMessageParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional
imageUrl
• imageUrl? : string
转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。 显示图片长宽比是 5:4
Returns: string
# Optional
imageUrlId
• imageUrlId? : string
审核通过的图片 ID,详见 {@link 使用审核通过的转发图片 (opens new window)}
Returns: string
# Optional
path
• path? : string
独立分包路径。详见 {@link 小游戏独立分包指南 (opens new window)}
Returns: string
# Optional
query
• query? : string
查询字符串,从这条转发消息进入后,可通过 mogs.getLaunchOptionsSync() 或 mogs.onShow() 获取启动参数中的 query。 必须是 key1=val1&key2=val2 的格式。
Returns: string
# Optional
title
• title? : string
转发标题,不传则默认使用当前小游戏的昵称。
Returns: string
# Optional
toCurrentGroup
• toCurrentGroup? : boolean
是否转发到当前群。该参数只对从群工具栏打开的场景下生效,默认转发到当前群,填入false时可转发到其他会话。
default
true
Returns: boolean
# Methods
# Optional
complete
▸ complete(res
: ShareAppMessageRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数(调用成功、失败都会执行)
# 参数:
属性 | 类型 |
---|---|
res | ShareAppMessageRes | Err |
# 返回值:
void
# Optional
fail
▸ fail(err
: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
属性 | 类型 |
---|---|
err | Err |
# 返回值:
void
# Optional
success
▸ success(res
: ShareAppMessageRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
属性 | 类型 |
---|---|
res | ShareAppMessageRes |
ShareAppMessageRes
属性 | 类型 | 描述 |
---|---|---|
errMsg | string | API 调用成功/失败的消息 |
# 返回值:
void