全部产品
云市场

获取容器的启动参数

更新时间:2019-09-12 17:15:04

此接口用于获取容器的启动参数(本 JS API 仅支持获取业务参数,对非业务参数或者缩写参数的传入不保证后果)。

getStartupParams 接口的使用方法

  1. AlipayJSBridge.call('getStartupParams', {
  2. key: ['url', 'xxx'] // 可选,根据 key 值过滤返回结果,不填返回全部
  3. }, function(result) {
  4. console.log(result);
  5. });

代码示例

  1. <script>
  2. function ready(callback) {
  3. // 如果 jsbridge 已经注入则直接调用
  4. if (window.AlipayJSBridge) {
  5. callback && callback();
  6. } else {
  7. // 如果没有注入则监听注入的事件
  8. document.addEventListener('AlipayJSBridgeReady', callback, false);
  9. }
  10. }
  11. ready(function() {
  12. // 有 key 参数的情况
  13. AlipayJSBridge.call('getStartupParams', {
  14. key: ['url']
  15. }, function(result) {
  16. alert(JSON.stringify(result));
  17. });
  18. // 没有参数的情况
  19. AlipayJSBridge.call('getStartupParams', function(result) {
  20. alert(JSON.stringify(result));
  21. });
  22. });
  23. </script>

API

  1. getStartupParams

入参

名称 类型 描述 必选 默认值
key Array 根据传的 key 来获得对应的 Key 的 value N null

出参

返回对应的启动参数,例如:{url: ‘https://taobao.com', xx: ‘其他启动参数’}

  • 如果没有入参,则返回所有的 startupParams 参数。
  • 如果有入参,根据入参返回对应的 value。
  • 如果启动参数中没有对应 key 值,则返回中不带这个 key,不做报错。

错误码描述(类型 Number)

错误码 描述
2 参数异常,key 为空数组,或者其它类型。
12 未知错误