WebhookListener (postfinancecheckout-java-sdk 4.0.2 API)

java.lang.Object
- ch.postfinance.sdk.model.WebhookListener

public class WebhookListener
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected Long`	`entity`
`protected List<String>`	`entityStates`
`protected Long`	`id`
`protected WebhookIdentity`	`identity`
`protected Long`	`linkedSpaceId`
`protected String`	`name`
`protected Boolean`	`notifyEveryChange`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected CreationEntityState`	`state`
`protected WebhookUrl`	`url`
`protected Integer`	`version`

Constructor Summary

Constructors
Constructor and Description

WebhookListener()

Constructors
Constructor and Description
`WebhookListener()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Long`	`getEntity()` The listener listens on state changes of the entity linked with the listener.
`List<String>`	`getEntityStates()` The target state identifies the state into which entities need to move into to trigger the webhook listener.
`Long`	`getId()` The ID is the primary key of the entity.
`WebhookIdentity`	`getIdentity()` The identity which will be used to sign messages sent by this listener.
`Long`	`getLinkedSpaceId()` The linked space id holds the ID of the space to which the entity belongs to.
`String`	`getName()` The webhook listener name is used internally to identify the webhook listener in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`CreationEntityState`	`getState()`
`WebhookUrl`	`getUrl()` The URL which is invoked by the listener to notify the application about the event.
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`Boolean`	`isNotifyEveryChange()` Defines whether the webhook listener is to be informed about every change made to the entity in contrast to state transitions only.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - entity
```
protected Long entity
```
  - entityStates
```
protected List<String> entityStates
```
  - id
```
protected Long id
```
  - identity
```
protected WebhookIdentity identity
```
  - linkedSpaceId
```
protected Long linkedSpaceId
```
  - name
```
protected String name
```
  - notifyEveryChange
```
protected Boolean notifyEveryChange
```
  - plannedPurgeDate
```
protected OffsetDateTime plannedPurgeDate
```
  - state
```
protected CreationEntityState state
```
  - url
```
protected WebhookUrl url
```
  - version
```
protected Integer version
```
- Constructor Detail
  - WebhookListener
```
public WebhookListener()
```
- Method Detail
  - getEntity
```
public Long getEntity()
```
    The listener listens on state changes of the entity linked with the listener.
    
    Returns:
    
    entity
  - getEntityStates
```
public List<String> getEntityStates()
```
    The target state identifies the state into which entities need to move into to trigger the webhook listener.
    
    Returns:
    
    entityStates
  - getId
```
public Long getId()
```
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
    
    Returns:
    
    id
  - getIdentity
```
public WebhookIdentity getIdentity()
```
    The identity which will be used to sign messages sent by this listener.
    
    Returns:
    
    identity
  - getLinkedSpaceId
```
public Long getLinkedSpaceId()
```
    The linked space id holds the ID of the space to which the entity belongs to.
    
    Returns:
    
    linkedSpaceId
  - getName
```
public String getName()
```
    The webhook listener name is used internally to identify the webhook listener in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.
    
    Returns:
    
    name
  - isNotifyEveryChange
```
public Boolean isNotifyEveryChange()
```
    Defines whether the webhook listener is to be informed about every change made to the entity in contrast to state transitions only.
    
    Returns:
    
    notifyEveryChange
  - getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
    
    Returns:
    
    plannedPurgeDate
  - getState
```
public CreationEntityState getState()
```
    Returns:
    
    state
  - getUrl
```
public WebhookUrl getUrl()
```
    The URL which is invoked by the listener to notify the application about the event.
    
    Returns:
    
    url
  - getVersion
```
public Integer getVersion()
```
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
    
    Returns:
    
    version
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WebhookListener

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entity

entityStates

id

identity

linkedSpaceId

name

notifyEveryChange

plannedPurgeDate

state

url

version

Constructor Detail

WebhookListener

Method Detail

getEntity

getEntityStates

getId

getIdentity

getLinkedSpaceId

getName

isNotifyEveryChange

getPlannedPurgeDate

getState

getUrl

getVersion

equals

hashCode

toString