com.tomtom.sdk.search:search/com.tomtom.sdk.search.model.feedback/FeedbackEvent

FeedbackEvent

data class FeedbackEvent(val sessionId: UUID, val type: FeedbackEventType, val resultId: FeedbackResultId, @IntRange(from = 0) val position: Int, val actionTime: Date)

Feedback event describing user interactions with the search results. The client application can report these events back to the search service to be used for analyzing and improving the search service.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard
constructor(sessionId: UUID, type: FeedbackEventType, resultId: FeedbackResultId, @IntRange(from = 0) position: Int, actionTime: Date)

Properties

Link copied to clipboard
val actionTime: Date

The time when the user interacted with the result.

Link copied to clipboard
val position: Int

The position of the chosen result in the list shown to the user.

Link copied to clipboard
val resultId: FeedbackResultId

The ID of the result chosen by the user. There are two types: ApplicationFeedbackResultId and ServiceFeedbackResultId. ApplicationFeedbackResultId can only be used with online feedback. To send offline feedback, create ServiceFeedbackResultId.searchResultId with Source.Offline.

Link copied to clipboard
val sessionId: UUID

The ID used to start the search session. It must be a valid UUID version UUID_VERSION.

Link copied to clipboard
val type: FeedbackEventType

The action type taken by the user.