Supported Bean: AddressListBean
AddressListBean
is responsible for displaying and managing
the user's address list.Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_ADDRESS_LIST (64)
Events
cancel | ||||
64007 | ||||
changeDefaultAddress | ||||
Changes the default address of the user to be the one specified by
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID |
64006 | |||
*addressID | The id of the address |
64006 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID |
|
createNewAddress | ||||
Creates a new empty address value and sets that as the active address on the bean |
64004 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_CREATE_NEW_ADDRESS |
||
deliveryMode | A value from the enumeration EnumWebSubscriptionDeliveryMode |
64011 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_DELIVERY_MODE |
|
deleteAddress | ||||
Event for deleting a list of address specified by EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID_LIST |
64002 | |||
*addressIDs | The list of address IDs to be used in the delete event |
64009 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID_LIST |
|
initAddress | ||||
Initializes the address bean with the parameters that are passed in |
64005 | |||
*addressID | The id of the address |
64006 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID |
|
SaveAddress | ||||
Event for saving an address that is set as the active address on the
address list bean. If there is no active address specified on the bean,
one can be created using the EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_DEVICE_ID
and EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_VALUE that are passed in. |
64001 | |||
*deviceID | The ID of the device |
64002 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_DEVICE_ID |
|
addressID | The id of the address |
64006 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_ID |
|
addressValue | The actual address. For instance, in the case of an email address, it is something like someone@company.com |
64001 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_VALUE |
|
deliveryMode | A value from the enumeration EnumWebSubscriptionDeliveryMode |
64011 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_DELIVERY_MODE |
|
dispName | The alias given to this address. |
64010 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_ADDRESS_DISPLAY_NAME |
|
isDefault | Indicates whether this address is the default address for the user |
64005 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_IS_DEFAULT |
|
sortAddresses | ||||
Sorts the addresses in the list accroding to the sort field defined
by EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_SORT_FIELD and in the sort order
defined by EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_SORT_ASCENDING |
64003 | |||
sortAsc | Indicates whether the addresses should be sorted in an ascending order |
64008 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_SORT_ASCENDING |
|
sortField | The field that will be used to sort the address list by. This is one of
the values defined in WebSubscriptionsSource |
64007 |
EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_ARGUMENT_SORT_FIELD |
Notes
* denotes required field.