Antom, leading provider of tailored payment solutions
Contact Us
登 录

element.on()

使用
element.on()
或
element.once()
方法为 Element 注册事件监听器。按照您的业务需求，选择以下调用场景：
  • 如果需要持续监听，调用
    element.on()
    注册持续监听，事件每次触发时都会执行回调函数。
  • 如果您希望事件只处理一次，调用
    element.once()
    注册一次性监听，事件触发一次后自动取消监听。
调用后，当 Element 内部触发对应事件时，会执行回调函数。
注意：事件名称与具体数据结构会因产品形态和集成场景略有不同，以下仅列出典型用法。

方法签名

调用此方法时，请使用以下标准方法签名格式：
JavaScript
TypeScript

参数

参数名称
类型
是否必需
描述
event
String
是
事件名称，如
'error'
等。
callback
Function
是
事件回调函数，参数为该事件对应的数据对象。

error
事件

用于监听 SDK 加载的 Web 页面，其包含以下参数：
参数名称
类型
是否必需
描述
code
String
是
错误码。具体信息请参阅错误码。
message
String
是
错误信息，描述错误的具体内容。
type
String
否
错误类型，用于区分错误的分类。
detail
Any
否
错误详情，可能包含额外的调试信息。

返回值

  • element.on()
    ：返回一个
    offFunction
    函数，调用该函数可取消本次监听。
  • element.once()
    ：无返回值。该方法会在事件触发一次后自动取消监听。

错误码

以下是调用
element.on()
方法监听到的相关错误码。
element.mount() 相关
antom.createElement() 相关
antom.confirmCardSetup() 相关

最佳实践

  • 事件名大小写敏感：请严格按照文档或 SDK 定义的事件名传入。
  • 多次注册：对同一事件多次调用
    element.on()
    会注册多个监听器，均将按照注册的顺序被触发。如不再需要，请结合业务需求自行管理或通过其他 API 取消监听。
  • 销毁时机：调用
    element.destroy()
    或
    element.unmount()
    后，对应 Element 的事件监听器将不再生效。