Interface ShoppingListRemoveLineItemAction

Produces the Shopping List Line Item Removed Message.

interface ShoppingListRemoveLineItemAction {
    action: "removeLineItem";
    lineItemId?: string;
    lineItemKey?: string;
    quantity?: number;
}

Hierarchy (View Summary)

Properties

action lineItemId? lineItemKey? quantity?

Properties

Readonlyaction

action: "removeLineItem"

Optional ReadonlylineItemId

lineItemId?: string

The id of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

Optional ReadonlylineItemKey

lineItemKey?: string

The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

Optional Readonlyquantity

quantity?: number

Amount to remove from the quantity of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.

Settings

Member Visibility

On This Page

Properties