Skip navigation links
A B C D E F G H I K L O P R S T U V 

A

accept(String, String, String) - Method in interface com.testfairy.LogEventFilter
Accept a log event entry.
addAudioRecording(AudioSample) - Static method in class com.testfairy.TestFairy
Send audio data as Wave/Riff (.wav) file.
addCheckpoint(String) - Static method in class com.testfairy.TestFairy
Deprecated.
addEvent(String) - Static method in class com.testfairy.TestFairy
Marks an event in session.
addNetworkEvent(URI, String, int, long, long, long, long, String) - Static method in class com.testfairy.TestFairy
Call this function to log your network events.
addNetworkEvent(URI, String, int, long, long, long, long, String, String, byte[], String, byte[]) - Static method in class com.testfairy.TestFairy
 
addScreenshot(Bitmap) - Static method in class com.testfairy.TestFairy
Adds a screenshot to the current moment in session.
addSessionStateListener(SessionStateListener) - Static method in class com.testfairy.TestFairy
 
addUserInteraction(UserInteractionKind, String, Map<String, String>) - Static method in class com.testfairy.TestFairy
Adds a new user interaction to the timeline.
afterTextChanged(Editable) - Method in class com.testfairy.StringFeedbackFormField
 
afterTextChanged(Editable) - Method in class com.testfairy.TextAreaFeedbackFormField
 
attachFile(File) - Static method in class com.testfairy.TestFairy
Attach a file to the session.
AudioSample - Class in com.testfairy
 
AudioSample(int, int, int, int, float, byte[]) - Constructor for class com.testfairy.AudioSample
Constructs an audio sample

B

beforeTextChanged(CharSequence, int, int, int) - Method in class com.testfairy.StringFeedbackFormField
 
beforeTextChanged(CharSequence, int, int, int) - Method in class com.testfairy.TextAreaFeedbackFormField
 
begin(Context, String) - Static method in class com.testfairy.TestFairy
Initialize a TestFairy session.
begin(Context, String, Map<String, String>) - Static method in class com.testfairy.TestFairy
Initialize a TestFairy session with additional options.
build() - Method in class com.testfairy.FeedbackOptions.Builder
Create FeedbackOptions
Builder() - Constructor for class com.testfairy.FeedbackOptions.Builder
 

C

com.testfairy - package com.testfairy
 

D

destroy() - Method in class com.testfairy.AudioSample
 
didLastSessionCrash(Context) - Static method in class com.testfairy.TestFairy
Indicate in runtime whether your last session was crashed.
disableAutoUpdate() - Static method in class com.testfairy.TestFairy
Disables auto update prompts for this session.
disableCrashHandler() - Static method in class com.testfairy.TestFairy
Disables the ability to capture crashes.
disableFeedbackForm() - Static method in class com.testfairy.TestFairy
Disables the ability to present users with feedback when devices is shaken, or if a screenshot is taken.
disableMetric(String) - Static method in class com.testfairy.TestFairy
Disables recording of a metric regardless of build settings.
disableVideo() - Static method in class com.testfairy.TestFairy
Disables the ability to capture video recording.
DistributionStatus - Interface in com.testfairy
 
DistributionStatusListener - Interface in com.testfairy
 

E

enableCrashHandler() - Static method in class com.testfairy.TestFairy
Enables the ability to capture crashes.
enableFeedbackForm(String) - Static method in class com.testfairy.TestFairy
Enables the ability to present the feedback form based on the method given.
enableMetric(String) - Static method in class com.testfairy.TestFairy
Enables recording of a metric regardless of build settings.
enableVideo(String) - Static method in class com.testfairy.TestFairy
Deprecated.
enableVideo(String, String, float) - Static method in class com.testfairy.TestFairy
Deprecated.

F

FeedbackContent - Class in com.testfairy
 
FeedbackContent(String, String, float) - Constructor for class com.testfairy.FeedbackContent
Constructs a new feedback content object
FeedbackContent(String, String, float, Bitmap) - Constructor for class com.testfairy.FeedbackContent
Constructs a new feedback content object
FeedbackContent(String, String, float, Bitmap, Map<String, String>) - Constructor for class com.testfairy.FeedbackContent
Constructs a new feedback content object
FeedbackFormField - Interface in com.testfairy
Common interface for all custom feedback form fields
FeedbackOptions - Class in com.testfairy
 
FeedbackOptions.Builder - Class in com.testfairy
 
FeedbackOptions.Callback - Interface in com.testfairy
 
FeedbackOptions.FeedbackInterceptor - Interface in com.testfairy
 
FeedbackVerifier - Interface in com.testfairy
 

G

getAttribute() - Method in interface com.testfairy.FeedbackFormField
Return the key name for the attribute represented by this form field
getAttribute() - Method in class com.testfairy.SelectFeedbackFormField
 
getAttribute() - Method in class com.testfairy.StringFeedbackFormField
 
getAttribute() - Method in class com.testfairy.TextAreaFeedbackFormField
 
getAttributes() - Method in class com.testfairy.FeedbackContent
Attached attributes
getAutoUpdateDownloadUrl() - Method in interface com.testfairy.DistributionStatus
If isAutoUpdateAvailable() returned true, then getAutoUpdateDownloadUrl() will also return the URL of the newer version's APK file.
getBitmap() - Method in class com.testfairy.FeedbackContent
Attached screenshot or null if there is none
getBitsPerSample() - Method in class com.testfairy.AudioSample
Returns number of bits per sample.
getBrowserUrl() - Method in class com.testfairy.FeedbackOptions
 
getChannels() - Method in class com.testfairy.AudioSample
Returns number of channels.
getDefaultFeedbackText() - Method in class com.testfairy.FeedbackOptions
 
getDistributionStatus(Context, String, DistributionStatusListener) - Static method in class com.testfairy.TestFairy
Query about the distribution status of this build.
getDurationInMilliseconds() - Method in class com.testfairy.AudioSample
Returns sample duration in milliseconds.
getEmail() - Method in class com.testfairy.FeedbackContent
User email
getFeedbackCallback() - Method in class com.testfairy.FeedbackOptions
 
getFeedbackFormFields() - Method in class com.testfairy.FeedbackOptions
 
getFeedbackInterceptor() - Method in class com.testfairy.FeedbackOptions
 
getSampleRate() - Method in class com.testfairy.AudioSample
Returns audio sample rate.
getSessionUrl() - Static method in class com.testfairy.TestFairy
Returns the address of the recorded session on TestFairy’s developer portal.
getSource() - Method in class com.testfairy.AudioSample
Returns source meta data.
getText() - Method in class com.testfairy.FeedbackContent
Feedback text
getTimestamp() - Method in class com.testfairy.AudioSample
Returns number of seconds passed since session start.
getTimestamp() - Method in class com.testfairy.FeedbackContent
Feedback time in seconds since the beginning of app launch or last call to TestFairy.begin()
getValue() - Method in interface com.testfairy.FeedbackFormField
Return the value for the attribute respressented by this form field
getValue() - Method in class com.testfairy.SelectFeedbackFormField
 
getValue() - Method in class com.testfairy.StringFeedbackFormField
 
getValue() - Method in class com.testfairy.TextAreaFeedbackFormField
 
getVerificationFailedMessage() - Method in interface com.testfairy.FeedbackVerifier
A callback to get the error message after a failure from verifyFeedback() method.
getVersion() - Static method in class com.testfairy.TestFairy
Returns SDK version (x.x.x) string

H

hideView(View) - Static method in class com.testfairy.TestFairy
Hides a specific view from appearing in the video generated.
hideWebViewElements(String) - Static method in class com.testfairy.TestFairy
Hides a specific html element from appearing in the video generated, detected via a CSS selector.

I

identify(String, Map<String, Object>) - Static method in class com.testfairy.TestFairy
identify(String) - Static method in class com.testfairy.TestFairy
Deprecated.
installCrashHandler(Context, String) - Static method in class com.testfairy.TestFairy
Installs the crash reporter without requiring a session.
installFeedbackHandler(Context, String) - Static method in class com.testfairy.TestFairy
Installs shake gesture recognizer for sending feedbacks.
intercept(FeedbackContent) - Method in interface com.testfairy.FeedbackOptions.FeedbackInterceptor
 
isAutoUpdateAvailable() - Method in interface com.testfairy.DistributionStatus
Is auto-update available for this build? Meaning, there is a newer version uploaded to TestFairy, with the same package name, but uploaded later and is marked as "auto-update".
isEmailFieldVisible() - Method in class com.testfairy.FeedbackOptions
 
isEmailMandatory() - Method in class com.testfairy.FeedbackOptions
 
isEnabled() - Method in interface com.testfairy.DistributionStatus
Is distribution enabled for this specific build? That is, an APK was uploaded to TestFairy with the same package name, version name and version code as the app we're running right now.
isTakeRecordingButtonVisible() - Method in class com.testfairy.FeedbackOptions
 
isTakeScreenshotButtonVisible() - Method in class com.testfairy.FeedbackOptions
 

K

kind - Variable in enum com.testfairy.UserInteractionKind
 

L

log(String, String) - Static method in class com.testfairy.TestFairy
Send a VERBOSE log message and log the exception to TestFairy.
LogEventFilter - Interface in com.testfairy
 
logThrowable(Throwable) - Static method in class com.testfairy.TestFairy
Send a throwable to TestFairy.
logThrowable(String) - Static method in class com.testfairy.TestFairy
Send a stacktrace to TestFairy.

O

onAutoUpdateAvailable(String) - Method in class com.testfairy.SessionStateListener
Callback when there is an update available.
onAutoUpdateDismissed() - Method in class com.testfairy.SessionStateListener
Callback when a user was displayed with a dialog asking if they would like to upgrade, and they clicked "No".
onAutoUpdateDownloadFailed() - Method in class com.testfairy.SessionStateListener
Callback when a download of an auto-update fails and stops.
onAutoUpdateDownloadStarted() - Method in class com.testfairy.SessionStateListener
Callback when a user was presented for a request of an auto-update, and then clicked "Yes".
onCreateView(Context, View) - Method in interface com.testfairy.FeedbackFormField
Like an adapter, implement this to return a custom view for the form element
onCreateView(Context, View) - Method in class com.testfairy.SelectFeedbackFormField
 
onCreateView(Context, View) - Method in class com.testfairy.StringFeedbackFormField
 
onCreateView(Context, View) - Method in class com.testfairy.TextAreaFeedbackFormField
 
onFeedbackCancelled() - Method in interface com.testfairy.FeedbackOptions.Callback
 
onFeedbackFailed(int, FeedbackContent) - Method in interface com.testfairy.FeedbackOptions.Callback
 
onFeedbackSent(FeedbackContent) - Method in interface com.testfairy.FeedbackOptions.Callback
 
onItemSelected(<any>, View, int, long) - Method in class com.testfairy.SelectFeedbackFormField
 
onNoAutoUpdateAvailable() - Method in class com.testfairy.SessionStateListener
Callback when session start was requested and there was no auto update available.
onNothingSelected(<any>) - Method in class com.testfairy.SelectFeedbackFormField
 
onResponse(DistributionStatus) - Method in interface com.testfairy.DistributionStatusListener
Called upon a response for getDistributionStatus().
onScreenshotTaken(Bitmap) - Method in interface com.testfairy.TakeScreenshotListener
Will be called by SDK with a Bitmap if screenshot is successfully taken
onSessionFailed() - Method in class com.testfairy.SessionStateListener
Callback when a session failed to started.
onSessionLengthReached(float) - Method in class com.testfairy.SessionStateListener
Callback when session length has reached.
onSessionStarted(String) - Method in class com.testfairy.SessionStateListener
Callback when a session has successfully started on TestFairy.
onSessionStopped() - Method in class com.testfairy.SessionStateListener
Callback when session recording stopped.
onTextChanged(CharSequence, int, int, int) - Method in class com.testfairy.StringFeedbackFormField
 
onTextChanged(CharSequence, int, int, int) - Method in class com.testfairy.TextAreaFeedbackFormField
 

P

pause() - Static method in class com.testfairy.TestFairy
Pauses the current session.

R

REASON_NETWORK_ERROR - Static variable in interface com.testfairy.FeedbackOptions.Callback
 
resume() - Static method in class com.testfairy.TestFairy
Resumes the recording of the current session.

S

SelectFeedbackFormField - Class in com.testfairy
A dropdown element to represent single choice options, like an HTML select node.
SelectFeedbackFormField(String, String, Map<String, String>, String) - Constructor for class com.testfairy.SelectFeedbackFormField
 
sendPendingFeedbacks(Context, String) - Static method in class com.testfairy.TestFairy
Sends all remaining feedbacks saved to disk due to lost internet connection or any kind of failure mode.
sendUserFeedback(String) - Static method in class com.testfairy.TestFairy
Send a feedback on behalf of the user.
sendUserFeedback(String, Bitmap) - Static method in class com.testfairy.TestFairy
Send a feedback on behalf of the user.
sendUserFeedback(Context, String, String) - Static method in class com.testfairy.TestFairy
Send a feedback on behalf of the user.
sendUserFeedback(Context, String, String, Bitmap) - Static method in class com.testfairy.TestFairy
Send a feedback on behalf of the user.
SessionStateListener - Class in com.testfairy
 
SessionStateListener() - Constructor for class com.testfairy.SessionStateListener
 
setAttribute(String, String) - Static method in class com.testfairy.TestFairy
Records an attribute that will be added to the session.
setBrowserUrl(String) - Method in class com.testfairy.FeedbackOptions.Builder
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.
setCallback(FeedbackOptions.Callback) - Method in class com.testfairy.FeedbackOptions.Builder
By setting the callback, You will be notified for "onFeedbackSent", "onFeedbackCancelled" and "onFeedbackFailed"
setCorrelationId(String) - Static method in class com.testfairy.TestFairy
Deprecated.
setDefaultText(String) - Method in class com.testfairy.FeedbackOptions.Builder
By setting a default text, you will override the initial content of the text area inside the feedback form.
setEmailFieldVisible(boolean) - Method in class com.testfairy.FeedbackOptions.Builder
Determines whether the "email field" in the Feedback form will be visible or not.
setEmailMandatory(boolean) - Method in class com.testfairy.FeedbackOptions.Builder
Determines whether the user has to add his email address to the feedback.
setEncryptionPolicy(boolean, boolean) - Static method in class com.testfairy.TestFairy
Override default encryption policy for encrypted sessions.
setFeedbackFormFields(List<FeedbackFormField>) - Method in class com.testfairy.FeedbackOptions.Builder
By setting this list, feedback forms can be customized with extra input fields.
setFeedbackInterceptor(FeedbackOptions.FeedbackInterceptor) - Method in class com.testfairy.FeedbackOptions.Builder
By setting this interface, feedback can become available for inspection before they are submitted.
setFeedbackOptions(FeedbackOptions) - Static method in class com.testfairy.TestFairy
You can customize the feedback form by creating FeedbackOptions, See FeedbackOptions.Builder
setFeedbackVerifier(FeedbackVerifier) - Static method in class com.testfairy.TestFairy
Provide a custom verification class for feedbacks.
setLogEventFilter(TestFairy.LogEventFilter) - Static method in class com.testfairy.TestFairy
Set a custom log event filter, get a callback whenever a new log has been read from device and accept each one by implementing a LogEventFilter.
setMaxSessionLength(float) - Static method in class com.testfairy.TestFairy
Sets the maximum recording time.
setPublicKey(String) - Static method in class com.testfairy.TestFairy
Enable end-to-end encryption for this session.
setRecordVideoButtonVisible(boolean) - Method in class com.testfairy.FeedbackOptions.Builder
By setting this flag, you can show/hide "Take a screen recording" button.
setScreenName(String) - Static method in class com.testfairy.TestFairy
Set a custom name for the current screen.
setSelection(String) - Method in class com.testfairy.SelectFeedbackFormField
Set current selection to given value
setServerEndpoint(String) - Static method in class com.testfairy.TestFairy
Override the server endpoint address for using with on-premise installations and private cloud configuration.
setTakeScreenshotButtonVisible(boolean) - Method in class com.testfairy.FeedbackOptions.Builder
By setting this flag, you can show/hide "Take a screenshot" button.
setUserId(String) - Static method in class com.testfairy.TestFairy
Use this function to tell TestFairy who is the user, It will help you to search the specific user in the TestFairy dashboard.
showFeedbackForm() - Static method in class com.testfairy.TestFairy
Displays the feedback activity.
showFeedbackForm(Bitmap) - Static method in class com.testfairy.TestFairy
Displays the feedback activity.
showFeedbackForm(Context, String, boolean) - Static method in class com.testfairy.TestFairy
Displays the feedback activity.
showFeedbackForm(Context, String, Bitmap) - Static method in class com.testfairy.TestFairy
Displays the feedback activity.
stop() - Static method in class com.testfairy.TestFairy
Stops the current session recording.
StringFeedbackFormField - Class in com.testfairy
A simple form element for editable string inputs
StringFeedbackFormField(String, String, String) - Constructor for class com.testfairy.StringFeedbackFormField
 

T

takeScreenshot() - Static method in class com.testfairy.TestFairy
Attempts to take a screenshot for the current moment in session.
takeScreenshot(Context, TakeScreenshotListener) - Static method in class com.testfairy.TestFairy
Attempts to take a screenshot and calls the listener with Bitmap if it is successful.
TakeScreenshotListener - Interface in com.testfairy
Callback for receiving Bitmap objects when a screenshot is taken
TestFairy - Class in com.testfairy
 
TestFairy() - Constructor for class com.testfairy.TestFairy
 
TestFairy.LogEventFilter - Interface in com.testfairy
Accept a log event entry.
TextAreaFeedbackFormField - Class in com.testfairy
A simple form element for editable text area.
TextAreaFeedbackFormField(String, String, String) - Constructor for class com.testfairy.TextAreaFeedbackFormField
 
toWavFile() - Method in class com.testfairy.AudioSample
Joins all audio chunks into one playable RIFF wave file.

U

updateLocation(Location) - Static method in class com.testfairy.TestFairy
Proxy onLocationChanged calls, and TestFairy will mark this location/time in the session being recorded.
UserInteractionKind - Enum in com.testfairy
Kind of user interactions to add to the session timeline.

V

valueOf(String) - Static method in enum com.testfairy.UserInteractionKind
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.testfairy.UserInteractionKind
Returns an array containing the constants of this enum type, in the order they are declared.
verifyFeedback(FeedbackContent) - Method in interface com.testfairy.FeedbackVerifier
A callback from the feedback form to verify the contents that the user has inputed.
A B C D E F G H I K L O P R S T U V 
Skip navigation links

Copyright 2021 TestFairy. All rights reserved.