0.3.38 • Published 1 year ago

@bytedance/mona-runtime v0.3.38

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

mona-runtime

mona 运行时

组件

Link

跳转组件,支持插件/应用间页面跳转

例子

import { Link } from '@bytedance/mona-runtime';

const Index = () => {
  return (
    <div>
      <Link to='/pages/home/index'>navigate to home </Link>
    </div>
  );
};

export default Index;

参数说明

参数说明是否必填类型默认值
to要跳转的页面路由string-

通用 API

navigateTo

路由跳转,跳转到新的页面

例子

import { navigateTo } from '@bytedance/mona-runtime';

navigateTo('/pages/home/index');

redirectTo

路由重定向,跳转并替换当前页面路由

例子

import { redirectTo } from '@bytedance/mona-runtime';

redirectTo('/pages/home/index');

飞鸽 API

飞鸽 API 分为两类

  • onXXXX开头的监听类 API,该类 API 接受回调函数作为参数,当在飞鸽中相应事件发生时,飞鸽会调用传过来的回调函数。
  • onXXXX开头的普通的 API,可以直接触发飞鸽中相应的动作

    注意:飞鸽 API 需要在开放平台中拥有相应的插件 API 权限包

addToInputBoxSafely

使用场景

复制信息到输入框,支持文字。

对应权限包

权限名称所属权限包所属权限组权限描述
AddToInputBoxSafely端操作权限端操作权限端复制能力

入参

名称类型是否必填描述
successFunction1. 用户未被拉黑   - 正在接待中 ,✅ 可复制   - 用户不在接待中,下列条件同时满足, ✅ 可复制      客服非离线      7 天内有会话     * 当前用户没有正在与其他客服对话
fail( error: { code: number, message: string } ) => void复制失败
datastring消息内容,length > 0

错误码

错误码错误描述排查
-100未知错误可能主应用内部原因。
-101缺参数、入参类型错误检查入参类型
-102无权限无权限,到开放平台申请权限包
-103应用不提供此能力本身无此能力/ 应用未实现此功能

示例代码

import { pigeon } from '@bytedance/mona-runtime';

pigeon.addToInputBoxSafely({
  data: '复制的文字',
  success: () => {},
  fail: error => {
    console.log(error);
  } // {code: -100, message: '未知错误'}
});

getInitInfo

使用场景

应用初始化时获取信息。

对应权限

权限名称所属权限包所属权限组权限描述对应参数
UserID端操作权限端操作权限用户 IDuser_id
ShopID店铺数据权限端数据权限店铺 IDshop_id
CustomsServiceNo客服数据权限端数据权限客服编号customer_service_id
CustomsServiceNickName客服数据权限端数据权限客服昵称customer_service_name

入参

名称类型是否必填描述
success(data: InitInfo) => void会将有权限的数据,透传给插件。
fail( error: { code: number, message: string } ) => void获取数据失败

出参

错误码

错误码错误描述排查
-100未知错误① 非飞鸽容器环境② 飞鸽内部原因,请咨询官方人员
-103应用不提供此能力本身无此能力/ 应用未实现此功能

示例代码

import { pigeon } from '@bytedance/mona-runtime';

pigeon.getInitInfo({
  success: data => {
    //  {
    //    user_id: '',
    //    customer_service_id '': ,
    //    customer_service_name: '',
    //    shop_id: ''
    //  }
    console.log(data);
  },
  fail: error => {
    console.log(error);
  } // {code: -100, message: '未知错误'}
});

onCurrentCustomerChange

使用场景

监听用户改变,当切换飞鸽左侧的用户时,会触发该 API 回调。 没申请 user_id 权限包时,将不会监听到对应变化。

对应权限

权限名称所属权限包所属权限组权限描述对应参数
UserID端操作权限端操作权限用户 IDuser_id

出参

类型含义
UserInfo{user_id: string}用户 openid

示例代码

import { pigeon } from '@bytedance/mona-runtime';

pigeon.onCurrentCustomerChange(data => {
  console.log(data);
  // {
  //   user_id: 'xxxxxxx',
  // }
});

onShow

使用场景

监听插件展示,当插件在飞鸽中前台展示时,会触发该 API 回调

  • 自定义按钮跳转, 会携带部分参数。申请权限后,才会携带相应数据。

  • 从 tab 点击进入

参数对应权限包

位置入口权限名称所属权限包所属权限组权限描述对应参数
位置 1售后单入口AfterSaleID售后单数据权限端数据权限售后单 IDafter_sale_id
位置 2商品单入口SkuOrderID订单数据权限端数据权限sku 单 IDsku_order_id
位置 3店铺单入口OrderID订单数据权限端数据权限订单 IDorder_id
位置 4商品列表入口ProductID商品数据权限端数据权限商品 IDproduct_id

npm.io npm.io

出参

key类型含义
showFrom0 | 1 | 2 | 3 | 40:点击 tab 进入自定义按钮跳转1:店铺单进入 order_id2:商品单进入 sku_order_id3:售后单进入 after_sale_id4:商品列表进入 product_id
queryinterface InitInfo {order_id?: string;sku_order_id?: product_id;after_sale_id?: string;product_id?: string;}官方参数。申请权限后,自定义按钮跳转会携带位置对应参数。
extraDataRecord<string,string>自定义按钮中配置的参数路径【飞鸽】-【客服管理】-【应用管理】- 【应用设置】-【非官方插件-设置】npm.ionpm.io

示例代码

import { pigeon } from '@bytedance/mona-runtime';

pigeon.onShow(data => {
  console.log(data);
  // {
  //   showFrom: 0,
  //   query: {},
  //   extraData: {},
  // }
});
0.3.39-alpha.0

1 year ago

0.3.39-alpha.1

1 year ago

0.3.38

1 year ago

0.3.38-alpha.3

1 year ago

0.3.38-alpha.2

1 year ago

0.3.38-alpha.0

1 year ago

0.3.38-alpha.1

1 year ago

0.3.37-alpha.0

1 year ago

0.3.37

1 year ago

0.3.36

1 year ago

0.3.33

1 year ago

0.3.32

2 years ago

0.3.31

2 years ago

0.3.31-alpha.0

2 years ago

0.3.30

2 years ago

0.3.27-alpha.9

2 years ago

0.3.27-alpha.8

2 years ago

0.3.27-alpha.7

2 years ago

0.3.27-alpha.6

2 years ago

0.3.27-alpha.5

2 years ago

0.3.27-alpha.3

2 years ago

0.3.27-alpha.2

2 years ago

0.3.27-alpha.1

2 years ago

0.3.27-alpha.0

2 years ago

0.3.27-alpha.11

2 years ago

0.3.27-alpha.10

2 years ago

0.3.17-alpha.0

2 years ago

0.3.21-alpha.0

2 years ago

0.3.21-alpha.2

2 years ago

0.3.21-alpha.1

2 years ago

0.3.21-alpha.4

2 years ago

0.3.21-alpha.3

2 years ago

0.3.20-beta.0

2 years ago

0.3.29-alpha.0

2 years ago

0.3.19-alpha.2

2 years ago

0.3.19-alpha.1

2 years ago

0.3.19-alpha.0

2 years ago

0.3.19-beta.0

2 years ago

0.3.19-beta.1

2 years ago

0.3.29

2 years ago

0.3.22-alpha.0

2 years ago

0.3.20

2 years ago

0.3.28

2 years ago

0.3.27

2 years ago

0.3.26

2 years ago

0.3.25

2 years ago

0.3.24

2 years ago

0.3.23

2 years ago

0.3.22

2 years ago

0.3.21

2 years ago

0.3.19

2 years ago

0.3.18

2 years ago

0.3.16-alpha.20

2 years ago

0.3.16-alpha.21

2 years ago

0.3.16

2 years ago

0.3.16-alpha.12

2 years ago

0.3.16-alpha.13

2 years ago

0.3.16-alpha.14

2 years ago

0.3.16-alpha.16

2 years ago

0.3.16-alpha.18

2 years ago

0.3.16-alpha.19

2 years ago

0.3.16-alpha.10

2 years ago

0.3.16-alpha.11

2 years ago

0.3.16-alpha.8

2 years ago

0.3.16-alpha.7

2 years ago

0.3.16-alpha.9

2 years ago

0.3.16-alpha.5

2 years ago

0.3.16-beta.3

2 years ago

0.3.16-beta.2

2 years ago

0.3.16-beta.1

2 years ago

0.3.16-beta.0

2 years ago

0.3.11-alpha.3

2 years ago

0.3.11-alpha.2

2 years ago

0.3.13-beta.1

2 years ago

0.3.13-beta.0

2 years ago

0.3.13-alpha.4

2 years ago

0.3.13-alpha.2

2 years ago

0.3.13-alpha.3

2 years ago

0.3.13-alpha.0

2 years ago

0.3.13-alpha.1

2 years ago

0.3.15

2 years ago

0.3.14

2 years ago

0.3.13

2 years ago

0.3.12

2 years ago

0.3.11

2 years ago

0.3.16-alpha.4

2 years ago

0.3.16-alpha.0

2 years ago

0.3.16-alpha.2

2 years ago

0.3.8

2 years ago

0.3.11-alpha.1

2 years ago

0.3.11-alpha.0

2 years ago

0.3.10

2 years ago

0.3.7-alpha.10

2 years ago

0.3.7-alpha.9

2 years ago

0.3.7

2 years ago

0.3.7-beta.0

2 years ago

0.3.7-beta.1

2 years ago

0.3.6-beta.1

2 years ago

0.3.7-alpha.4

2 years ago

0.3.7-alpha.3

2 years ago

0.3.7-alpha.6

2 years ago

0.3.7-alpha.5

2 years ago

0.3.7-alpha.0

2 years ago

0.3.7-alpha.2

2 years ago

0.3.7-alpha.1

2 years ago

0.3.7-alpha.8

2 years ago

0.3.7-alpha.7

2 years ago

0.3.6

2 years ago

0.3.6-alpha.16

2 years ago

0.3.6-alpha.15

2 years ago

0.3.6-alpha.18

2 years ago

0.3.6-alpha.17

2 years ago

0.3.6-alpha.14

2 years ago

0.3.6-alpha.19

2 years ago

0.3.6-alpha.13

2 years ago

0.3.6-alpha.10

2 years ago

0.3.6-beta.0

2 years ago

0.3.6-alpha.12

2 years ago

0.3.6-alpha.11

2 years ago

0.3.6-alpha.9

2 years ago

0.3.6-alpha.8

2 years ago

0.3.6-alpha.5

2 years ago

0.3.6-alpha.7

2 years ago

0.3.6-alpha.6

2 years ago

0.3.4-alpha.0

3 years ago

0.3.4-alpha.1

3 years ago

0.3.4-alpha.4

3 years ago

0.3.4-alpha.5

3 years ago

0.3.4-alpha.2

3 years ago

0.3.4-alpha.3

3 years ago

0.3.4-alpha.6

2 years ago

0.3.4-alpha.7

2 years ago

0.3.0

3 years ago

0.3.5

2 years ago

0.3.2

3 years ago

0.3.1

3 years ago

0.3.4

3 years ago

0.3.3

3 years ago

0.3.5-alpha.3

2 years ago

0.3.5-alpha.2

2 years ago

0.3.5-alpha.0

3 years ago

0.3.6-alpha.1

2 years ago

0.3.6-alpha.0

2 years ago

0.3.6-alpha.3

2 years ago

0.3.6-alpha.2

2 years ago

0.3.6-alpha.4

2 years ago

0.3.3-alpha.0

3 years ago

0.2.39-beta.0

3 years ago

0.2.35-alpha.1

3 years ago

0.2.35-alpha.2

3 years ago

0.2.35-alpha.3

3 years ago

0.2.35-alpha.4

3 years ago

0.2.35-alpha.5

3 years ago

0.2.35-alpha.6

3 years ago

0.2.35-alpha.7

3 years ago

0.2.40-beta.0

3 years ago

0.2.35-alpha.8

3 years ago

0.2.35-alpha.9

3 years ago

0.2.35-alpha.0

3 years ago

0.2.39-beta.6

3 years ago

0.2.39-beta.5

3 years ago

0.2.39-beta.4

3 years ago

0.2.39-beta.1

3 years ago

0.2.35-beta.1

3 years ago

0.2.35-beta.0

3 years ago

0.2.35-alpha.13

3 years ago

0.2.35-alpha.12

3 years ago

0.2.35-alpha.11

3 years ago

0.2.35-alpha.10

3 years ago

0.2.38-alpha.33

3 years ago

0.2.38-alpha.34

3 years ago

0.2.38-alpha.31

3 years ago

0.2.38-alpha.32

3 years ago

0.2.38-alpha.30

3 years ago

0.2.38-alpha.28

3 years ago

0.2.38-alpha.29

3 years ago

0.2.38-alpha.26

3 years ago

0.2.38-alpha.27

3 years ago

0.2.38-alpha.24

3 years ago

0.2.38-alpha.25

3 years ago

0.2.33-alpha.8

3 years ago

0.2.33-alpha.7

3 years ago

0.2.38-alpha.11

3 years ago

0.2.38-alpha.12

3 years ago

0.2.38-alpha.10

3 years ago

0.2.40-alpha.0

3 years ago

0.2.38-alpha.22

3 years ago

0.2.38-alpha.23

3 years ago

0.2.38-alpha.20

3 years ago

0.2.38-alpha.21

3 years ago

0.2.38-alpha.1

3 years ago

0.2.38-alpha.0

3 years ago

0.2.38-alpha.5

3 years ago

0.2.38-alpha.4

3 years ago

0.2.38-alpha.3

3 years ago

0.2.38-alpha.2

3 years ago

0.2.38-alpha.19

3 years ago

0.2.38-alpha.9

3 years ago

0.2.38-alpha.8

3 years ago

0.2.38-alpha.17

3 years ago

0.2.38-alpha.7

3 years ago

0.2.38-alpha.18

3 years ago

0.2.38-alpha.6

3 years ago

0.2.38-alpha.15

3 years ago

0.2.38-alpha.16

3 years ago

0.2.38-alpha.13

3 years ago

0.2.38-alpha.14

3 years ago

0.2.40

3 years ago

0.2.39-alpha.0

3 years ago

0.2.37

3 years ago

0.2.36

3 years ago

0.2.35

3 years ago

0.2.34

3 years ago

0.2.33

3 years ago

0.2.36-alpha.1

3 years ago

0.2.36-alpha.0

3 years ago

0.2.33-alpha.4

3 years ago

0.2.33-alpha.3

3 years ago

0.2.33-alpha.6

3 years ago

0.2.33-alpha.5

3 years ago

0.2.33-alpha.2

3 years ago

0.2.33-alpha.1

3 years ago

0.2.27

3 years ago

0.2.26

3 years ago

0.2.25

3 years ago

0.2.24

3 years ago

0.2.23

3 years ago

0.2.22

3 years ago

0.2.21

3 years ago

0.2.20

3 years ago

0.2.28-alpha.0

3 years ago

0.2.33-alpha.0

3 years ago

0.2.29-alpha.0

3 years ago

0.2.31-alpha.0

3 years ago

0.2.30

3 years ago

0.2.20-alpha.15

3 years ago

0.2.20-alpha.14

3 years ago

0.2.32

3 years ago

0.2.31

3 years ago

0.2.32-alpha.1

3 years ago

0.2.32-alpha.0

3 years ago

0.2.29

3 years ago

0.2.28

3 years ago

0.2.12-alpha.3

3 years ago

0.2.12-alpha.4

3 years ago

0.2.12-alpha.5

3 years ago

0.2.12-alpha.6

3 years ago

0.2.19

3 years ago

0.2.18

3 years ago

0.2.17

3 years ago

0.2.20-alpha.4

3 years ago

0.2.20-alpha.3

3 years ago

0.2.20-alpha.2

3 years ago

0.2.20-alpha.1

3 years ago

0.2.20-alpha.0

3 years ago

0.2.16

3 years ago

0.2.15

3 years ago

0.2.14

3 years ago

0.2.13

3 years ago

0.2.12

3 years ago

0.2.20-beta.0

3 years ago

0.2.20-alpha.9

3 years ago

0.2.20-beta.3

3 years ago

0.2.20-alpha.8

3 years ago

0.2.20-beta.4

3 years ago

0.2.20-alpha.7

3 years ago

0.2.20-beta.1

3 years ago

0.2.20-alpha.6

3 years ago

0.2.20-beta.2

3 years ago

0.2.20-alpha.5

3 years ago

0.2.14-alpha.10

3 years ago

0.2.19-alpha.0

3 years ago

0.2.19-alpha.2

3 years ago

0.2.19-alpha.1

3 years ago

0.2.14-alpha.13

3 years ago

0.2.14-alpha.14

3 years ago

0.2.14-alpha.12

3 years ago

0.2.12-beta.1

3 years ago

0.2.12-beta.0

3 years ago

0.2.12-beta.2

3 years ago

0.2.14-alpha.7

3 years ago

0.2.14-alpha.6

3 years ago

0.2.14-alpha.5

3 years ago

0.2.14-alpha.4

3 years ago

0.2.14-alpha.3

3 years ago

0.2.14-alpha.2

3 years ago

0.2.14-alpha.1

3 years ago

0.2.14-alpha.0

3 years ago

0.2.14-alpha.9

3 years ago

0.2.14-alpha.8

3 years ago

0.2.18-alpha.0

3 years ago

0.2.20-alpha.13

3 years ago

0.2.20-alpha.12

3 years ago

0.2.17-alpha.0

3 years ago

0.2.20-alpha.11

3 years ago

0.2.20-alpha.10

3 years ago

0.2.17-alpha.1

3 years ago

0.2.17-alpha.2

3 years ago

0.2.12-alpha.0

3 years ago

0.2.12-alpha.1

3 years ago

0.2.11

3 years ago

0.2.10

3 years ago

0.2.9-alpha.1

3 years ago

0.2.9-alpha.0

3 years ago

0.2.9-alpha.2

3 years ago

0.2.9

3 years ago

0.2.3-alpha.3

3 years ago

0.2.3-alpha.2

3 years ago

0.2.3-alpha.1

3 years ago

0.2.0-alpha.19

3 years ago

0.2.0-alpha.18

3 years ago

0.2.0-alpha.26

3 years ago

0.2.0-alpha.25

3 years ago

0.2.0-alpha.24

3 years ago

0.2.0-alpha.23

3 years ago

0.2.4-alpha.2

3 years ago

0.2.0-alpha.22

3 years ago

0.2.4-alpha.1

3 years ago

0.2.0-alpha.21

3 years ago

0.2.4-alpha.0

3 years ago

0.2.0-alpha.20

3 years ago

0.2.4-alpha.3

3 years ago

0.2.7-alpha.2

3 years ago

0.2.7-alpha.0

3 years ago

0.2.7-alpha.1

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.2.7

3 years ago

0.2.6

3 years ago

0.2.8

3 years ago

0.2.3

3 years ago

0.2.2

3 years ago

0.2.5

3 years ago

0.2.4

3 years ago

0.2.0-alpha.17

3 years ago

0.2.0-alpha.16

3 years ago

0.2.0-alpha.15

3 years ago

0.2.0-alpha.14

3 years ago

0.2.0-alpha.13

3 years ago

0.2.0-alpha.12

3 years ago

0.2.0-alpha.11

3 years ago

0.2.0-alpha.8

3 years ago

0.2.0-alpha.10

3 years ago

0.2.0-alpha.9

3 years ago

0.2.0-alpha.7

3 years ago

0.2.0-alpha.6

4 years ago

0.2.0-alpha.5

4 years ago

0.1.4

3 years ago

0.1.1

4 years ago

0.1.3

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago