List#

Whenever you're dealing with a list in your template, you're actually working with a List object.

Attributes#

AttributeDescription
idID of the list.
referenceA unique identifier for this list, often used in sharing.
typeIdThe List Type ID.
userIdIf logged in, this will be the user ID of the owner for this list.
sessionIdIf a guest, this will contain the unique session ID used to identify this guest.
defaultWhether this list is marked as the default list for users.
titleThe title of this list.
lastIpA record of the last known IP for the guest or user of this list.

Methods#

MethodDescription
getItems()Returns an Item query.
getItem(element, params)Returns an Item object for the given element, and query params.
hasItem(item)Whether the provided item is in this list.
getAddItemUrl(element, params)Returns the URL to add an item to the list.
getToggleItemUrl(element, params)Returns the URL to remove an item from the list.
getRemoveItemUrl(element, params)Returns the URL to toggle an item in the list.

Previous ← Item Queries Next Item →