io.sphere.sdk.customers.commands

Class CustomerVerifyEmailCommand

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.CommandImpl<Customer>

io.sphere.sdk.customers.commands.CustomerVerifyEmailCommand

All Implemented Interfaces:

SphereRequest<Customer>, Command<Customer>

public final class CustomerVerifyEmailCommand
extends CommandImpl<Customer>

Verifies customer's email using a token.

withUpdateableCustomer(client(), customer -> {
    assertThat(customer.isEmailVerified()).isFalse();
    final int ttlMinutes = 15;
    final Command<CustomerToken> createTokenCommand =
            CustomerCreateEmailTokenCommand.ofCustomerId(customer.getId(), ttlMinutes);

    final CustomerToken customerToken = client().executeBlocking(createTokenCommand);
    final String tokenValue = customerToken.getValue();//this token needs to be sent via email to the customer

    final Command<Customer> verifyEmailCommand = CustomerVerifyEmailCommand.ofTokenValue(tokenValue);
    final Customer loadedCustomer = client().executeBlocking(verifyEmailCommand);
    assertThat(loadedCustomer.isEmailVerified()).isTrue();

    Query<CustomerEmailVerifiedMessage> messageQuery = MessageQuery.of()
            .withPredicates(m -> m.resource().is(customer))
            .withSort(m -> m.createdAt().sort().desc())
            .withLimit(1L)
            .forMessageType(CustomerEmailVerifiedMessage.MESSAGE_HINT);

    assertEventually(() -> {
        final PagedQueryResult<CustomerEmailVerifiedMessage> queryResult = client().executeBlocking(messageQuery);
        assertThat(queryResult.head()).isPresent();
    });
    return loadedCustomer;
});
See the test code.

See Also:

Customer, Customer.isEmailVerified(), CustomerCreateEmailTokenCommand

Method Summary

Modifier and Type	Method and Description
String	getId() Deprecated.
String	getTokenValue()
Long	getVersion() Deprecated.
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
static CustomerVerifyEmailCommand	of(Versioned<Customer> customer, CustomerToken customerToken) Deprecated. use ofTokenValue(String) or ofCustomerToken(CustomerToken)
static CustomerVerifyEmailCommand	of(Versioned<Customer> customer, String tokenValue) Deprecated. use ofTokenValue(String) or ofCustomerToken(CustomerToken)
static CustomerVerifyEmailCommand	ofCustomerToken(CustomerToken customerToken) Creates a command to verify the email of a customer.
static CustomerVerifyEmailCommand	ofTokenValue(String tokenValue) Creates a command to verify the email of a customer.

Methods inherited from class io.sphere.sdk.commands.CommandImpl

deserialize

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize

Method Detail

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

Specified by:

jacksonJavaType in class CommandImpl<Customer>

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Returns:

http request intent

of

@Deprecated
public static CustomerVerifyEmailCommand of(Versioned<Customer> customer,
                                                        String tokenValue)

Deprecated. use ofTokenValue(String) or ofCustomerToken(CustomerToken)

Creates a command to verify the email of a customer.

Parameters:

customer - unused

tokenValue - the value of the token which customer email address should be confirmed

Returns:

command

of

@Deprecated
public static CustomerVerifyEmailCommand of(Versioned<Customer> customer,
                                                        CustomerToken customerToken)

Deprecated. use ofTokenValue(String) or ofCustomerToken(CustomerToken)

Creates a command to verify the email of a customer.

Parameters:

customer - unused

customerToken - the token object

Returns:

command

ofTokenValue

public static CustomerVerifyEmailCommand ofTokenValue(String tokenValue)

Creates a command to verify the email of a customer.

Parameters:

tokenValue - the value of the token which customer email address should be confirmed

Returns:

command

ofCustomerToken

public static CustomerVerifyEmailCommand ofCustomerToken(CustomerToken customerToken)

Creates a command to verify the email of a customer.

Parameters:

customerToken - the token object

Returns:

command

getId

@Deprecated
 @Nullable
public String getId()

Deprecated.

getVersion

@Deprecated
 @Nullable
public Long getVersion()

Deprecated.

getTokenValue

public String getTokenValue()