sdk/com.mapbox.search.analytics/FeedbackEvent

FeedbackEvent

class FeedbackEvent @JvmOverloads constructor(val reason: String, val text: String? = null, val screenshot: Bitmap? = null, val sessionId: String? = null, val feedbackId: String? = null)

Feedback information, provided by user.

Constructors

Link copied to clipboard
@JvmOverloads
fun FeedbackEvent(reason: String, text: String? = null, screenshot: Bitmap? = null, sessionId: String? = null, feedbackId: String? = null)

Types

Link copied to clipboard
annotation class FeedbackReason

Search feedback reason.

Functions

Link copied to clipboard
fun copy(reason: String = this.reason, text: String? = this.text, screenshot: Bitmap? = this.screenshot, sessionId: String? = this.sessionId, feedbackId: String? = this.feedbackId): FeedbackEvent

Creates new FeedbackEvent from current instance.

Properties

Link copied to clipboard
val feedbackId: String? = null

Unique feedback ID. If the passed value is null, the id will be generated inside the Search SDK. Normally SDK users don't have to provide it explicitly. One of the cases, when users should provide their own id, is when they want to have associated events in different analytics systems.

Link copied to clipboard
val reason: String

Reason for user's feedback.

Link copied to clipboard
val screenshot: Bitmap? = null

Screenshot with useful information for improving Search SDK.

Link copied to clipboard
val sessionId: String? = null

Unique ID for identifying several related Mapbox events per session.

Link copied to clipboard
val text: String? = null

User's feedback text. Should be provided, if "Other" feedback reason was specified.