-
- All Implemented Interfaces:
public class BaseUpdateContext
Contains the basic information needed for communicating with VoiceKit.
-
-
Field Summary
Fields Modifier and Type Field Description private Action
action
private Domain
domain
private final Screen
screen
private Intent
intent
private final VoiceStatus
status
private final PageDirection
pageDirection
private Integer
pageIndex
private Boolean
isFirstResume
private Integer
resumeTimeInSeconds
private final Diagnostics
diagnostics
private String
shoppingSessionId
private SearchLocation
searchedLocation
private List<SearchLocation>
locations
private final String
orderId
private VoiceGeoLocation
currentLocation
-
Constructor Summary
Constructors Constructor Description BaseUpdateContext(Action action, Domain domain, Screen screen, Intent intent, VoiceStatus status, PageDirection pageDirection, Integer pageIndex, Boolean isFirstResume, Integer resumeTimeInSeconds, Diagnostics diagnostics, String shoppingSessionId, SearchLocation searchedLocation, List<SearchLocation> locations, String orderId, VoiceGeoLocation currentLocation)
-
Method Summary
Modifier and Type Method Description Action
getAction()
Represents an action used for communicating with VoiceKit component. Unit
setAction(Action action)
Represents an action used for communicating with VoiceKit component. Domain
getDomain()
Represents the voice domain. Unit
setDomain(Domain domain)
Represents the voice domain. Screen
getScreen()
Represents the current screen Intent
getIntent()
Intent will be received from VoiceKit when action is SHOW_SCREEN or UPDATE_CONTEXT Unit
setIntent(Intent intent)
Intent will be received from VoiceKit when action is SHOW_SCREEN or UPDATE_CONTEXT VoiceStatus
getStatus()
Represents the status from the Commerce Service. PageDirection
getPageDirection()
Represents the direction used for scrolling the voice results. Integer
getPageIndex()
Represents the current page index when there are search results. Unit
setPageIndex(@SerializedName(value = "page_index") Integer pageIndex)
Represents the current page index when there are search results. Boolean
getIsFirstResume()
Indicates if is a first voice resume operation. Unit
setIsFirstResume(@SerializedName(value = "is_first_time_resume") Boolean isFirstResume)
Indicates if is a first voice resume operation. Integer
getResumeTimeInSeconds()
Indicates the time passed from the last user interaction with the system. Unit
setResumeTimeInSeconds(@SerializedName(value = "resume_time_in_seconds") Integer resumeTimeInSeconds)
Indicates the time passed from the last user interaction with the system. Diagnostics
getDiagnostics()
Represents the TNNLU diagnostics for specific domain. String
getShoppingSessionId()
Current shopping session id Unit
setShoppingSessionId(@SerializedName(value = "shopping_session_id") String shoppingSessionId)
Current shopping session id SearchLocation
getSearchedLocation()
Searched location. Unit
setSearchedLocation(@SerializedName(value = "search_location") SearchLocation searchedLocation)
Searched location. List<SearchLocation>
getLocations()
List of locations when a search by address was done. Unit
setLocations(@SerializedName(value = "search_locations") List<SearchLocation> locations)
List of locations when a search by address was done. String
getOrderId()
Current order id VoiceGeoLocation
getCurrentLocation()
Current location Unit
setCurrentLocation(@SerializedName(value = "current_location") VoiceGeoLocation currentLocation)
Current location String
toString()
Returns a string representation of the object. -
-
Constructor Detail
-
BaseUpdateContext
BaseUpdateContext(Action action, Domain domain, Screen screen, Intent intent, VoiceStatus status, PageDirection pageDirection, Integer pageIndex, Boolean isFirstResume, Integer resumeTimeInSeconds, Diagnostics diagnostics, String shoppingSessionId, SearchLocation searchedLocation, List<SearchLocation> locations, String orderId, VoiceGeoLocation currentLocation)
-
-
Method Detail
-
setAction
Unit setAction(Action action)
Represents an action used for communicating with VoiceKit component.
-
getIntent
Intent getIntent()
Intent will be received from VoiceKit when action is SHOW_SCREEN or UPDATE_CONTEXT
-
setIntent
Unit setIntent(Intent intent)
Intent will be received from VoiceKit when action is SHOW_SCREEN or UPDATE_CONTEXT
-
getStatus
VoiceStatus getStatus()
Represents the status from the Commerce Service.
-
getPageDirection
PageDirection getPageDirection()
Represents the direction used for scrolling the voice results.
-
getPageIndex
Integer getPageIndex()
Represents the current page index when there are search results.
-
setPageIndex
Unit setPageIndex(@SerializedName(value = "page_index") Integer pageIndex)
Represents the current page index when there are search results.
-
getIsFirstResume
Boolean getIsFirstResume()
Indicates if is a first voice resume operation.
-
setIsFirstResume
Unit setIsFirstResume(@SerializedName(value = "is_first_time_resume") Boolean isFirstResume)
Indicates if is a first voice resume operation.
-
getResumeTimeInSeconds
Integer getResumeTimeInSeconds()
Indicates the time passed from the last user interaction with the system.
-
setResumeTimeInSeconds
Unit setResumeTimeInSeconds(@SerializedName(value = "resume_time_in_seconds") Integer resumeTimeInSeconds)
Indicates the time passed from the last user interaction with the system.
-
getDiagnostics
Diagnostics getDiagnostics()
Represents the TNNLU diagnostics for specific domain.
-
getShoppingSessionId
String getShoppingSessionId()
Current shopping session id
-
setShoppingSessionId
Unit setShoppingSessionId(@SerializedName(value = "shopping_session_id") String shoppingSessionId)
Current shopping session id
-
getSearchedLocation
SearchLocation getSearchedLocation()
Searched location. This field will contain the entry information about the search location. E.g 'find parking near Post Street' will have a searchLocation with query 'Post Street'
-
setSearchedLocation
Unit setSearchedLocation(@SerializedName(value = "search_location") SearchLocation searchedLocation)
Searched location. This field will contain the entry information about the search location. E.g 'find parking near Post Street' will have a searchLocation with query 'Post Street'
-
getLocations
List<SearchLocation> getLocations()
List of locations when a search by address was done. E.g "find parking/order food near Post Street". Multiple Post Street locations are received.
-
setLocations
Unit setLocations(@SerializedName(value = "search_locations") List<SearchLocation> locations)
List of locations when a search by address was done. E.g "find parking/order food near Post Street". Multiple Post Street locations are received.
-
getOrderId
String getOrderId()
Current order id
-
getCurrentLocation
VoiceGeoLocation getCurrentLocation()
Current location
-
setCurrentLocation
Unit setCurrentLocation(@SerializedName(value = "current_location") VoiceGeoLocation currentLocation)
Current location
-
-
-
-