Offer Management

Details about the Offer Management user journey

The onOfferManagement callback

When the Assistant detects that the user is trying to enquire about offers, it invokes the callback associated with the Offer Management user journey. The callback looks like this:

public OfferAppState onOfferManagement(OfferInfo offerInfo, OfferManagementUserJourney offerManagementUserJourney) {
  1. Open the offers page

  2. Return the ViewOffer as the state and SUCCESS as the condition

public OfferAppState onOfferManagement(OfferInfo offerInfo, OfferManagementUserJourney offerManagementUserJourney) {
    // Navigate to the offers page
    return new ViewOfferAppState(ViewOfferAppState.SUCCESS);
}

Note that currently, the OfferInfo object does not contain any additional data that would be useful to further understand the kind of offer the user is looking for. That could get added in the future

Sample Utterances that could trigger Offers

The following are some examples of commands that could trigger this journey

  • "where is my offer"

  • "any offers"

  • "show me offers"

Supported AppStates

The following AppStates are supported.

  • VIEW_OFFER (ViewOfferAppState): To be returned when the app handles the navigation request

  • UNSUPPORTED (UnsupportedAppState): To be returned when the app is not ready to handle navigation yet. The Assistant will speak out an appropriate prompt to the user.

The Slang Retail Assistant provides a special AppState 'WAITING' (WaitingAppState) that is common across all UserJourney types for completing asynchronous operations within the callback. Refer to the Asynchronous Action Handling section for details of how to deal with asynchronous operations.

Supported Conditions

The following Conditions are supported for each of the AppStates supported by the Assistant

App State

App State Condition

Description

VIEW_OFFER (ViewOfferAppState)

  • SUCCESS

  • FAILURE

  • The offer page was successfully opened

  • There was a failure while opening the offer page

Assistant Prompts

Based on the App State and the Condition that was set, the Assistant will speak out an appropriate message to the user. You can examine the default set of prompts configured for the Assistant through the Console and also customize it to your needs. Refer to the Customizing the Assistant section for details.

Last updated