io.sphere.sdk.subscriptions

Interface Payload<T>

Type Parameters:

T - the resource type

All Known Subinterfaces:

MessageSubscriptionPayload<T>, ResourceCreatedPayload<T>, ResourceDeletedPayload<T>, ResourceUpdatedPayload<T>

public interface Payload<T>

Common interface for all subscription payloads.

Method Summary

Modifier and Type	Method and Description
String	getNotificationType() Identifies the payload.
String	getProjectKey() The key of the project.
Reference<T>	getResource() A reference to the resource that triggered this delivery.
UserProvidedIdentifiers	getResourceUserProvidedIdentifiers()

Method Detail

getProjectKey

String getProjectKey()

The key of the project. Useful if the same queue is filled from multiple projects.

Returns:

the project key Project.getKey()

getNotificationType

String getNotificationType()

Identifies the payload.

Returns:

the payload type

getResource

Reference<T> getResource()

A reference to the resource that triggered this delivery.

Returns:

the reference to the resource that triggered this delivery

getResourceUserProvidedIdentifiers

@Nullable
UserProvidedIdentifiers getResourceUserProvidedIdentifiers()