FeedbackEvent

public struct FeedbackEvent

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.

Lifecycle

  • Construct a FeedbackEvent.

    Declaration

    Swift

    public init(sessionID: UUID, type: FeedbackEventType, resultID: FeedbackResultID, position: Int, actionTime: Date)

    Parameters

    sessionID

    The UUID used to identify a search session.
    type

    The action taken by the user.
    resultID

    The ID of the result chosen by the user.
    position

    The position of the chosen result in the list shown to the user, starting with 0.
    actionTime

    The time when the user interacted with the result.

Public

  • The UUID used to identify a search session.

    Declaration

    Swift

    public let sessionID: UUID

  • The action taken by the user.

    Declaration

    Swift

    public let type: FeedbackEventType

  • The ID of the result chosen by the user.

    Declaration

    Swift

    public let resultID: FeedbackResultID

  • The position of the chosen result in the list shown to the user, starting with 0.

    Declaration

    Swift

    public let position: Int

  • The time when the user interacted with the result.

    Declaration

    Swift

    public let actionTime: Date