PaymentRequestUpdateEvent:updateWith() 方法

安全上下文:此功能仅在安全上下文(HTTPS)中可用,在某些或所有支持的浏览器中。

updateWith()PaymentRequestUpdateEvent接口的方法,用于更新现有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 对象的Array,其属性在PaymentRequestEvent.modifiers中描述。

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

shippingAddressErrors 可选 已弃用 非标准

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

shippingOptions 可选 已弃用 非标准

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

total 可选

具有与 displayItems 中对象相同属性的对象,提供支付的更新总计。确保这等于 displayItems 中所有项目的总和。不会自动计算。在应付总金额发生变化时,您必须自己更新此值。这使您可以灵活地处理税费、折扣和其他对收取的总价的调整。

返回值

无(undefined)。

规范

规范
支付请求 API
# dom-paymentrequestupdateevent-updatewith

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。