MOGS API 文档

# Interface: NavigateToMiniProgramParams ‹Err›

• NavigateToMiniProgramParams‹Err›()

# Type parameters:

▪ Err: MogsRes

# Type parameters

▪ Err: MogsRes

# Properties

# Readonly appId

• appId: string

要打开的小程序 appId

Returns: string

# Optional Readonly envVersion

• envVersion? : "develop" | "trial" | "release"

要打开的小程序版本

description 仅在当前小程序为开发版或体验版时此参数有效。

description 如果当前小程序是正式版，则打开的小程序必定是正式版。

description 可选值：

  • 'develop'：开发版；
  • 'trial'：体验版；
  • 'release'：正式版；

default 'release'

Returns: "develop" | "trial" | "release"

# Optional Readonly extraData

• extraData? : object

需要传递给目标小游戏的数据

description 目标小游戏可以在 mogs.onShow、mogs.getLaunchOptionsSync 中获取到这份数据数据。

Returns: object

# Optional Readonly path

• path? : string

打开的页面路径

description 如果为空则打开首页。

description path 中 ? 后面的部分会成为 query，在小游戏的 mogs.onShow 回调函数、mogs.getLaunchOptionsSync 中可以获取到 query 数据。

description 对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。

Returns: string

# Methods

# Optional complete

▸ complete(res: NavigateToMiniProgramRes | Err): void

Inherited from MogsParams.complete

接口调用结束的回调函数（调用成功、失败都会执行）

# 参数:

属性 类型
res NavigateToMiniProgramRes | Err

# 返回值:

void

# Optional fail

▸ fail(err: Err): void

Inherited from MogsParams.fail

接口调用失败的回调函数

# 参数:

属性 类型
err Err

# 返回值:

void

# Optional success

▸ success(res: NavigateToMiniProgramRes): void

Inherited from MogsParams.success

接口调用成功的回调函数

# 参数:

属性 类型
res NavigateToMiniProgramRes

NavigateToMiniProgramRes

属性 类型 描述
errMsg string API 调用成功/失败的消息

# 返回值:

void

← GetSettingRes →