StructuredSearchResponse

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract class StructuredSearchResponse

Response from the current StructuredSearchSession. It's either the end of the search (its destination) or options to proceed (search candidates).

Inheritors

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class Destination(val structuredSearchCandidate: StructuredSearchCandidate) : StructuredSearchResponse

Contains a StructuredSearchCandidate as destination when the search path ended.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class NextState(val structuredSearchState: StructuredSearchState) : StructuredSearchResponse

Contains a StructuredSearchState when the search path hasn't ended. The client uses the candidates from StructuredSearchState for the StructuredSearchSession to proceed with the search.