com.testfairy

Class FeedbackOptions.Builder

java.lang.Object

com.testfairy.FeedbackOptions.Builder

Enclosing class:

FeedbackOptions

public static class FeedbackOptions.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FeedbackOptions	build() Create FeedbackOptions
FeedbackOptions.Builder	setBrowserUrl(java.lang.String url) By setting the url, You will override the default TestFairy feedback form, The specified url will be opened in the browser, when the user will want to provide a feedback.
FeedbackOptions.Builder	setCallback(FeedbackOptions.Callback callback) By setting the callback, You will be notified for "onFeedbackSent", "onFeedbackCancelled" and "onFeedbackFailed"
FeedbackOptions.Builder	setDefaultText(java.lang.String defaultText) By setting a default text, you will override the initial content of the text area inside the feedback form.
FeedbackOptions.Builder	setEmailFieldVisible(boolean visible) Determines whether the "email field" in the Feedback form will be visible or not.
FeedbackOptions.Builder	setEmailMandatory(boolean mandatory) Determines whether the user has to add his email address to the feedback.
FeedbackOptions.Builder	setFeedbackFormFields(java.util.List<FeedbackFormField> feedbackFormFields) By setting this list, feedback forms can be customized with extra input fields.
FeedbackOptions.Builder	setFeedbackInterceptor(FeedbackOptions.FeedbackInterceptor feedbackInterceptor) By setting this interface, feedback can become available for inspection before they are submitted.
FeedbackOptions.Builder	setRecordVideoButtonVisible(boolean enabled) By setting this flag, you can show/hide "Take a screen recording" button.
FeedbackOptions.Builder	setTakeScreenshotButtonVisible(boolean enabled) By setting this flag, you can show/hide "Take a screenshot" button.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setEmailFieldVisible

public FeedbackOptions.Builder setEmailFieldVisible(boolean visible)

Determines whether the "email field" in the Feedback form will be visible or not. default is true

Parameters:

visible - Boolean

Returns:

Builder

setEmailMandatory

public FeedbackOptions.Builder setEmailMandatory(boolean mandatory)

Determines whether the user has to add his email address to the feedback. if true, it aquatically setEmailFieldVisible = true. default is false

Parameters:

mandatory - Boolean

Returns:

Builder

setCallback

public FeedbackOptions.Builder setCallback(FeedbackOptions.Callback callback)

By setting the callback, You will be notified for "onFeedbackSent", "onFeedbackCancelled" and "onFeedbackFailed"

Parameters:

callback - FeedbackOptions.Callback

Returns:

Builder

setBrowserUrl

public FeedbackOptions.Builder setBrowserUrl(java.lang.String url)

By setting the url, You will override the default TestFairy feedback form, The specified url will be opened in the browser, when the user will want to provide a feedback. The following parameters will be added (if exsist) to the url sessionUrl, correlationId, email, timestamp, platform, packageName, versionName and versionCode. Note setCallback(), setEmailMandatory(), setEmailFieldVisible() are invalid in this case.

Parameters:

url - String

Returns:

Builder

setDefaultText

public FeedbackOptions.Builder setDefaultText(java.lang.String defaultText)

By setting a default text, you will override the initial content of the text area inside the feedback form. This way, you can standardize the way you receive feedbacks by specifying guidelines to your users.

Parameters:

defaultText -

Returns:

setTakeScreenshotButtonVisible

public FeedbackOptions.Builder setTakeScreenshotButtonVisible(boolean enabled)

By setting this flag, you can show/hide "Take a screenshot" button. Set to true if never called.

Parameters:

enabled -

Returns:

setRecordVideoButtonVisible

public FeedbackOptions.Builder setRecordVideoButtonVisible(boolean enabled)

By setting this flag, you can show/hide "Take a screen recording" button. Set to true if never called.

Parameters:

enabled -

Returns:

setFeedbackInterceptor

public FeedbackOptions.Builder setFeedbackInterceptor(FeedbackOptions.FeedbackInterceptor feedbackInterceptor)

By setting this interface, feedback can become available for inspection before they are submitted. The contents of the feedback can be modified. i.e A business may want to append a string consist of important meta data to the end of user message.

Parameters:

feedbackInterceptor -

Returns:

setFeedbackFormFields

public FeedbackOptions.Builder setFeedbackFormFields(java.util.List<FeedbackFormField> feedbackFormFields)

By setting this list, feedback forms can be customized with extra input fields. Calling with a null list will enable the default fields, namely email and feedback message.

Parameters:

feedbackFormFields -

Returns:

build

public FeedbackOptions build()

Create FeedbackOptions

Returns:

FeedbackOptions