PaymentRequestUpdateEvent: updateWith() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

PaymentRequestUpdateEvent 接口的 updateWith() 方法用于更新现有的 PaymentRequest 的详细信息。

语法

js
updateWith(details)

参数

details

一个对象或一个解析为对象的 Promise,指定应用于支付请求的更改。

displayItems 可选

一个对象数组,每个对象描述支付请求的一行项目。这些代表收据或发票上的项目,每个项目都有以下属性:

amount

描述项目货币价值的对象。此对象包含以下字段:

currency

一个字符串,包含一个有效的 3 字母 ISO 4217 货币标识符(ISO 4217),指示 value 支付所使用的货币。

value

一个字符串,包含一个有效的十进制值,表示构成支付金额的货币数量。此字符串只能包含一个可选的前导 "-" 来表示负值,然后是一个或多个数字(0-9),以及一个可选的小数点(".",不考虑地区设置),后面至少跟一个数字。不允许有空格。

label

一个字符串,指定要收费的项目或服务的可读名称或描述。这可能会由 用户代理 显示给用户,具体取决于界面的设计。

pending

一个布尔值,如果指定的 amount 尚未确定,则为 true。这可用于显示依赖于收货地址、送货选项等选择的运费或税费等项目。用户代理可以显示此信息,但并非必须这样做。

error 可选 已弃用 非标准

一个字符串,指定要显示给用户的错误消息。调用 updateWith() 时,在更新的数据中包含 error 会导致 用户代理 将文本显示为一般错误消息。对于特定于地址字段的错误,请使用 shippingAddressErrors 字段。

modifiers 可选

一个 PaymentDetailsModifier 对象数组,其属性在 PaymentRequestEvent.modifiers 中进行描述。

例如,您可以使用其中一个来根据选定的付款方式调整总支付金额(“5% 现金折扣!”)。

shippingAddressErrors 可选 已弃用 非标准

一个对象,其中包含未能验证的送货地址每个属性的错误消息。

shippingOptions 可选 已弃用 非标准

一个对象数组,每个对象描述用户可以选择的一个可用送货选项。

total 可选

一个具有与 displayItems 中的对象相同的属性的对象,提供支付的更新总计。确保此值等于 displayItems 中所有项目的总和。此值不会自动计算。每次总金额到期更改时,您都必须自行更新此值。这使您能够灵活地处理税费、折扣以及其他对总收取价格的调整。

返回值

无(undefined)。

规范

规范
Payment Request API
# dom-paymentrequestupdateevent-updatewith

浏览器兼容性