Discussion

Initialize a TestFairy session.

Discussion

Initialize a TestFairy session with options.

Discussion

Initialize the TestFairy SDK with only crash handling. No sessions will be recorded.

Discussion

Initialize the TestFairy SDK with shake for feedback enabled. No sessions will be recorded.

Discussion

Initialize the TestFairy SDK with shake for feedback enabled. No sessions will be recorded. Enables the ability to present the feedback form based on the method given. Valid values include “shake”, “screenshot” or “shake|screenshot”.

Discussion

Disables a previously installed feedback handler. Stops listening user shakes to prompt feedback alerts.

Discussion

Change the server endpoint for use with on-premise hosting. Please contact support or sales for more information. Must be called before begin

Discussion

Returns SDK version (x.x.x) string

Discussion

Hides a specific view from appearing in the video generated. Holds a weak reference to the view

Discussion

Removes a view added to hideView. Useful for table views which reuse cells, where cells only need to be hidden conditionally.

Discussion

Hides a specific html element from appearing in your WKWebView

Discussion

Pushes the feedback view controller. Hook a button to this method to allow users to provide feedback about the current session. All feedback will appear in your build report page, and in the recorded session page.

Discussion

Programmatically display the feedback form to users. Users can provide feedback about the current session. All feedback will appear in your build report page, and in the recorded session page.

Discussion

Displays the feedback form. Allow users to provide feedback without prior call to begin. All feedback will appear in your build report page, and in “Feedbacks” tab.

This method is different from showFeedbackForm by that it does not require a call to begin().

Discussion

Start collecting feedback by having your users either capture a screenshot or recording before filling the Feedback form. All feedbacks will appear in your build report page, and on the “Feedbacks” tab.

Does not require a call to begin().

Discussion

Send a feedback on behalf of the user. Call when using a in-house feedback view controller with a custom design and feel. Feedback will be associated with the current session.

Discussion

Send a feedback on behalf of the user. Call when using a in-house feedback view controller with a custom design and feel. Feedback will be associated with the current session.

Discussion

Proxy didUpdateLocation delegate values and these locations will appear in the recorded sessions. Useful for debugging actual long/lat values against what the user sees on screen.

Discussion

Marks a checkpoint in session. Use this text to tag a session with a checkpoint name. Later you can filter sessions where your user passed through this checkpoint.

Discussion

Marks an event in session timeline. Use this text to tag a session with an event name. Later you can filter sessions where your user passed through this event.

Discussion

Adds a new user interaction to the timeline. Can be used by non-native UI frameworks to report user interactions such as clicks, long-clicks and double clicks.

Discussion

Sets a correlation identifier for this session. This value can be looked up via web dashboard. For example, setting correlation to the value of the user-id after they logged in. Can be called only once per session (subsequent calls will be ignored.)

Discussion

Sets a correlation identifier for this session. This value can be looked up via web dashboard. For example, setting correlation to the value of the user-id after they logged in. Can be called only once per session (subsequent calls will be ignored.)

Discussion

Sets a correlation identifier for this session. This value can be looked up via web dashboard. For example, setting correlation to the value of the user-id after they logged in. Can be called only once per session (subsequent calls will be ignored.)

Discussion

Pauses the current session. This method stops recoding of the current session until resume has been called.

Discussion

Resumes the recording of the current session. This method resumes a session after it was paused.

Discussion

Returns the address of the recorded session on testfairy’s developer portal. Will return nil if recording not yet started.

Discussion

Takes a screenshot and sends it to TestFairy

Discussion

Takes a screenshot. Can return nil.

Discussion

Adds a screenshot to the current moment in session. Overrides the current screen recording system

Discussion

Set the name of the current screen. Useful for single page applications which use a single UIViewController.

Discussion

Stops the current session recording. Unlike ‘pause’, when calling ‘resume’, a new session will be created and will be linked to the previous recording. Useful if you want short session recordings of specific use-cases of the app. Hidden views and user identity will be applied to the new session as well, if started.

Discussion

Records a session level attribute which can be looked up via web dashboard.

Discussion

Records a user identified as an attribute. We recommend passing values such as email, phone number, or user id that your app may use.

Discussion

Remote logging. These logs will be sent to the server, but will not appear in the console.

Discussion

Attach a file to the session. A maximum of 5 files may be attached. Each file cannot be more than 15 mb in size. In order to see if the file successfully uploads or fails, please view the logs.

Discussion

Query to see if the previous session crashed. Can be called before or after calling begin.

Discussion

Enables the ability to capture crashes. TestFairy crash handler is installed by default. Once installed it cannot be uninstalled. Must be called before begin.

Discussion

Disables the ability to capture crashes. TestFairy crash handler is installed by default. Once installed it cannot be uninstalled. Must be called before begin.

Discussion

Enables recording of a metric regardless of build settings. Valid values include “cpu”, “memory”, “logcat”, “battery”, “network-requests” A metric cannot be enabled and disabled at the same time, therefore if a metric is also disabled, the last call to enable to disable wins. Must be called be before begin.

Discussion

Disables recording of a metric regardless of build settings. Valid values include “cpu”, “memory”, “logcat”, “battery”, “network-requests” A metric cannot be enabled and disabled at the same time, therefore if a metric is also disabled, the last call to enable to disable wins. Must be called be before begin.

Discussion

Enables recording of logs regardless of build settings. Must be called before begin.

Discussion

Disables recording of logs regardless of build settings. Must be called before begin.

Discussion

Enables the ability to capture video recording regardless of build settings. Valid values for policy include “always” and “wifi” Valid values for quality include “high”, “low”, “medium” Values for fps must be between 0.1 and 2.0. Value will be rounded to the nearest frame.

Discussion

Enables the ability to capture video recording regardless of build settings. Valid values for policy include “always” and “wifi”

Discussion

Disables the ability to capture video recording. Must be called before begin.

Discussion

Enables the ability to present the feedback form based on the method given. Valid values include “shake”, “screenshot” or “shake|screenshot”. If an unrecognized method is passed, the value defined in the build settings will be used. Must be called before begin.

Discussion

Disables the ability to present users with feedback when devices is shaken, or if a screenshot is taken. Must be called before begin.

Discussion

Disable auto updates for this build. Even if there’s a newer build available through TestFairy, ignore it, and continue using the current build. Must be called before begin

Discussion

Sets the maximum recording time. Minimum value is 60 seconds, else the value defined in the build settings will be used. The maximum value is the lowest value between this value and the value defined in the build settings. Time is rounded to the nearest minute. Must be called before begin.

Discussion

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

Discussion

Customize the feedback form

Accepted dictionary values: @{ @“defaultText”: @“Default feedback text”, @“isEmailMandatory”: @NO|@YES, @“isEmailVisible”: @NO|@YES }

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.

isEmailMandatory: Determines whether the user has to add his email address to the feedback. Default is true

isEmailVisible: Determines whether the email field is displayed in the feedback form. Default is true

Discussion

You can customize the feedback form by creating FeedbackOptions, See TestFairyFeedbackOptions

Discussion

Query the distribution status of this build. Distribution is not required for working with the TestFairy SDK, meaning, you can use the SDK with the App Store.

The distribution status can be either “enabled” or “disabled”, and optionally, can have an auto-update. This method is useful if you’re using TestFairy in your development stage and want to know if you expired the distribution of this version in your dashboard.

Possible response keys:

response[@“status”] = @“enabled” or @“disabled” response[@“autoUpdateDownloadUrl”] = @“”

Discussion

Enable end-to-end encryption for this session. Screenshots and logs will be encrypted using this RSA key. Please refer to the documentation to learn more about the subject and how to create public/private key pair.

Discussion

Define whether logs or screenshots are encrypted. Should be called before setPublicKey

Discussion

Set the delegate object to listent to TestFairy events. See @TestFairySessionStateDelegate for more information

Discussion

Log network calls to TestFairy.

Discussion

Log network calls to TestFairy

Discussion

Log network calls to TestFairy, include request and response payloads.

Discussion

Send an NSError to TestFairy. Note, this function is limited to 5 errors.

Discussion

Force crash (only for testing purposes)