io.sphere.sdk.shoppinglists.commands.updateactions

Class SetDescription

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<ShoppingList>

io.sphere.sdk.shoppinglists.commands.updateactions.SetDescription

All Implemented Interfaces:

UpdateAction<ShoppingList>

public final class SetDescription
extends UpdateActionImpl<ShoppingList>

Sets the description of the shopping list.

See also ShoppingListInStoreUpdateCommand.

withUpdateableShoppingList(client(), shoppingList -> {
    final LocalizedString newDescription = en(randomString());
    final ShoppingList updatedShoppingList = client().executeBlocking(
            ShoppingListUpdateCommand.of(shoppingList, SetDescription.of(newDescription)));

    assertThat(updatedShoppingList.getDescription()).isEqualTo(newDescription);

    return updatedShoppingList;
});
See the test code.

See Also:

ShoppingList.getDescription()

Method Summary

Modifier and Type	Method and Description
LocalizedString	getDescription()
static SetDescription	of(LocalizedString description)

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

getAction

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

Method Detail

of

public static SetDescription of(@Nullable
                                LocalizedString description)

getDescription

@Nullable
public LocalizedString getDescription()