EXPDBA Class Reference

Inherits from NSObject
Declared in EXPDBA.h

Overview

The EXPDBA class provides the main interface to the DBA module. This module requires the primary EXPCore.framework.

Other Methods

+ requestBeginRecording

Requests DBA to record the screen.

+ (void)requestBeginRecording

Discussion

Displays a dialog which asks the user for permission. Recording starts if the user agrees. If DBA is already recording (or in a state which prevents a new recording), calling this method has no effect.

Declared In

EXPDBA.h

+ stopRecording

Stops DBA recording.

+ (void)stopRecording

Discussion

This is an asynchronous operation.

If DBA is not recording, calling this method has no effect.

Declared In

EXPDBA.h

+ stopRecordingAndOnComplete:

Stops DBA recording and executes the given callback when the operation is complete.

+ (void)stopRecordingAndOnComplete:(nonnull void ( ^ ) ( void ))callback

Discussion

This is an asynchronous operation.

If DBA is not recording, calling this method has no effect.

Declared In

EXPDBA.h

+ isRecording

Checks if DBA is recording.

+ (BOOL)isRecording

Return Value

YES if DBA is recording, NO if DBA is not recording

Declared In

EXPDBA.h

+ setRecordingPermission:

Enables recording through use of the API or an implemented custom prompt. Includes additional options such as recording for one session only.

+ (void)setRecordingPermission:(DBAPermissionResponse)permissionResponse

Parameters

permissionResponse

The response selected. Values include DBAPermissionResponseAllowedOnce, DBAPermissionResponseAllowedAlways, DBAPermissionResponseRejected, DBAPermissionResponseUndefined. Selection persists between sessions (with the exception of DBAPermissionResponseAllowedOnce).

Declared In

EXPDBA.h

+ resetRecordingPermission

Resets recording permission to the default value of ‘NotSet’.

+ (void)resetRecordingPermission

Discussion

If requestBeginRecording is called after permissions are reset, the default permission prompt will be displayed.

Declared In

EXPDBA.h

+ logPageChange:

Manually adds a page break to the DBA session.

+ (void)logPageChange:(NSString *_Nonnull)pageName

Parameters

pageName

The name of the page displayed in the player

Discussion

This is not required in most cases as changes between UIViewControllers are detected automatically.

Declared In

EXPDBA.h

+ maskView:

Masks a view in a DBA recording.

+ (void)maskView:(UIView *_Nonnull)view

Parameters

view

The view to mask

Discussion

Use this method to mark a view you wish to mask. This method is typically called from a view controller’s viewDidLoad() method.

See Also

Declared In

EXPDBA.h

+ unmaskView:

Removes the mask from a view in a DBA recording.

+ (void)unmaskView:(UIView *_Nonnull)view

Parameters

view

The view to unmask

See Also

Declared In

EXPDBA.h

+ maskedViews

Gets the list of masked views.

+ (NSArray *_Nonnull)maskedViews

Declared In

EXPDBA.h

+ setTestGroupValue:forKey:

Adds a test group value for the given predefined test group key.

+ (void)setTestGroupValue:(NSString *_Nonnull)value forKey:(NSString *_Nonnull)key

Parameters

value

a new value for the given key
key

the test group key

Declared In

EXPDBA.h

Debug

+ setMaskingDebugEnabled:

Enables masking debug which adds translucent red areas on screen to indicate masked areas.

+ (void)setMaskingDebugEnabled:(BOOL)enabled

Parameters

enabled

YES to enable masking debug, NO to disable

Discussion

Disabled by default and must be called after the SDK is started.

Declared In

EXPDBA.h

+ isMaskingDebugEnabled

Checks if masking debug is enabled.

+ (BOOL)isMaskingDebugEnabled

Return Value

YES if enabled, NO otherwise

Declared In

EXPDBA.h