io.sphere.sdk.messages

Interface Message

All Superinterfaces:

CreationTimestamped, Identifiable<Message>, Referenceable<Message>, Resource<Message>, ResourceIdentifiable<Message>, ResourceView<Message,Message>, Timestamped, Versioned<Message>

All Known Subinterfaces:

GenericMessage<T>, SimpleOrderMessage, SimpleProductMessage

All Known Implementing Classes:

CategoryCreatedMessage, CategorySlugChangedMessage, CustomerAddressAddedMessage, CustomerAddressChangedMessage, CustomerAddressRemovedMessage, CustomerCompanyNameSetMessage, CustomerCreatedMessage, CustomerDateOfBirthSetMessage, CustomerDeletedMessage, CustomerEmailChangedMessage, CustomerEmailVerifiedMessage, CustomerGroupSetMessage, CustomerPasswordUpdatedMessage, CustomLineItemStateTransitionMessage, DeliveryAddedMessage, DeliveryAddressSetMessage, DeliveryItemsUpdatedMessage, DeliveryRemovedMessage, GenericMessageImpl, InventoryEntryCreatedMessage, InventoryEntryDeletedMessage, InventoryEntryQuantitySetMessage, LineItemStateTransitionMessage, MessageImpl, OrderBillingAddressSetMessage, OrderCreatedMessage, OrderCustomerEmailSetMessage, OrderCustomerGroupSetMessage, OrderCustomerSetMessage, OrderDeletedMessage, OrderDiscountCodeAddedMessage, OrderDiscountCodeStateSetMessage, OrderEditAppliedMessage, OrderImportedMessage, OrderLineItemDistributionChannelSetMessage, OrderPaymentAddedMessage, OrderPaymentStateChangedMessage, OrderReturnShipmentStateChangedMessage, OrderShipmentStateChangedMessage, OrderShippingAddressSetMessage, OrderShippingInfoSetMessage, OrderStateChangedMessage, OrderStateTransitionMessage, OrderStoreSetMessage, ParcelAddedToDeliveryMessage, ParcelItemsUpdatedMessage, ParcelMeasurementsUpdatedMessage, ParcelRemovedFromDeliveryMessage, ParcelTrackingDataUpdatedMessage, PaymentCreatedMessage, PaymentInteractionAddedMessage, PaymentStatusInterfaceCodeSetMessage, PaymentStatusStateTransitionMessage, PaymentTransactionAddedMessage, PaymentTransactionStateChangedMessage, ProductAddedToCategoryMessage, ProductCreatedMessage, ProductDeletedMessage, ProductImageAddedMessage, ProductPriceDiscountsSetMessage, ProductPriceExternalDiscountSetMessage, ProductPublishedMessage, ProductRemovedFromCategoryMessage, ProductRevertedStagedChangesMessage, ProductSelectionCreatedMessage, ProductSelectionDeletedMessage, ProductSelectionProductAddedMessage, ProductSelectionProductRemovedMessage, ProductSlugChangedMessage, ProductStateTransitionMessage, ProductUnpublishedMessage, ProductVariantAddedMessage, ProductVariantDeletedMessage, ReturnInfoAddedMessage, ReturnInfoSetMessage, ReviewCreatedMessage, ReviewRatingSetMessage, ReviewStateTransitionMessage, StoreCreatedMessage, StoreDeletedMessage, StoreProductSelectionsChangedMessage

public interface Message
extends Resource<Message>

A message represents a change or an action performed on a resource (like an Order or a Product). Messages can be seen as a subset of the change history for a resource inside a project. It is a subset because not all changes on resources result in messages. Consult MessageQuery how to use messages.

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> messageClass)
com.fasterxml.jackson.databind.JsonNode	getPayload() Gets the top level fields not mapped by the current message class.
Reference<?>	getResource()
UserProvidedIdentifiers	getResourceUserProvidedIdentifiers()
Long	getResourceVersion()
Long	getSequenceNumber()
String	getType()
static Reference<Message>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
default Reference<Message>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Message>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Message> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

getResource

Reference<?> getResource()

getResourceVersion

Long getResourceVersion()

getSequenceNumber

Long getSequenceNumber()

getType

String getType()

getResourceUserProvidedIdentifiers

@Nullable
UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

getPayload

com.fasterxml.jackson.databind.JsonNode getPayload()

Gets the top level fields not mapped by the current message class.

Returns:

json

toReference

default Reference<Message> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Message>

Specified by:

toReference in interface Resource<Message>

Returns:

reference

as

<T> T as(Class<T> messageClass)

referenceOfId

static Reference<Message> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference