public class CustomerNotification
extends java.lang.Object
Represents a customer notification resource returned from the API.
Customer Notifications represent the notification which is due to be sent to a customer after an event has happened. The event, the resource and the customer to be notified are all identified in the links property.
Note that these are ephemeral records - once the notification has been actioned in some way, it is no longer visible using this API.
Restricted: This API is currently only available for approved integrators - please get in touch if you would like to use this API.
| Modifier and Type | Class and Description |
|---|---|
static class |
CustomerNotification.ActionTaken |
static class |
CustomerNotification.Links |
static class |
CustomerNotification.Type |
| Modifier and Type | Method and Description |
|---|---|
CustomerNotification.ActionTaken |
getActionTaken()
The action that was taken on the notification.
|
java.lang.String |
getActionTakenAt()
Fixed timestamp, recording when this action was taken.
|
java.lang.String |
getActionTakenBy()
A string identifying the integrator who was able to handle this notification.
|
java.lang.String |
getId()
The id of the notification.
|
CustomerNotification.Links |
getLinks() |
CustomerNotification.Type |
getType()
The type of notification the customer shall receive.
|
public CustomerNotification.ActionTaken getActionTaken()
The action that was taken on the notification. Currently this can only be handled, which means the integrator sent the notification themselves.
public java.lang.String getActionTakenAt()
Fixed timestamp, recording when this action was taken.
public java.lang.String getActionTakenBy()
A string identifying the integrator who was able to handle this notification.
public java.lang.String getId()
The id of the notification.
public CustomerNotification.Links getLinks()
public CustomerNotification.Type getType()
The type of notification the customer shall receive.