public
interface
AlertsApi
| com.mapsted.alerts.AlertsApi |
 Known Indirect Subclasses
|
Class Overview
AlertsApi class is used to get alerts for a property. It also provides callbacks for alerts which should be activated based on user position transition in the property. Use Mapsted Hub dashboard to setup the alerts for your property.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| interface | AlertsApi.Events | ||||||||||
| interface | AlertsApi.Lifecycle | ||||||||||
| interface | AlertsApi.Repo | ||||||||||
| interface | AlertsApi.ScheduledAlertTriggerListener | Callback for scheduled alert triggers when user is at the location. | |||||||||
| interface | AlertsApi.Setup | ||||||||||
| interface | AlertsApi.ShowAlertListener | ||||||||||
| interface | AlertsApi.Views | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract boolean |
addAlertsOnChangeListener(AlertsOnChangeListener listener)
Register onChangeListener for property user is interested in but not necessarily at the property.
| ||||||||||
| abstract boolean |
addScheduledAlertTriggerListener(AlertsApi.ScheduledAlertTriggerListener listener)
Set callback for when scheduled alerts triggers while the user is at a property.
| ||||||||||
| abstract AlertsApi.Events | events() | ||||||||||
| abstract AlertsApi.Lifecycle | lifecycle() | ||||||||||
| abstract boolean |
removeAlertsOnChangeListener(AlertsOnChangeListener listener)
Unregister a previously registered callback.
| ||||||||||
| abstract boolean |
removeScheduledAlertTriggerListener(AlertsApi.ScheduledAlertTriggerListener listener)
Remove callback for when scheduled alerts triggers while the user is at a property.
| ||||||||||
| abstract AlertsApi.Repo | repo() | ||||||||||
| abstract AlertsApi.Setup | setup() | ||||||||||
| abstract AlertsApi.Views | views() | ||||||||||
Public Methods
public abstract boolean addAlertsOnChangeListener (AlertsOnChangeListener listener)
Register onChangeListener for property user is interested in but not necessarily at the property.
public abstract boolean addScheduledAlertTriggerListener (AlertsApi.ScheduledAlertTriggerListener listener)
Set callback for when scheduled alerts triggers while the user is at a property.
Parameters
| listener | callback with the ScheduledAlert that got triggered. |
|---|
public abstract boolean removeAlertsOnChangeListener (AlertsOnChangeListener listener)
Unregister a previously registered callback.
public abstract boolean removeScheduledAlertTriggerListener (AlertsApi.ScheduledAlertTriggerListener listener)
Remove callback for when scheduled alerts triggers while the user is at a property.
Parameters
| listener | callback with the ScheduledAlert that got triggered. |
|---|