Qualaroo

@class Qualaroo;

This object provides an API for displayed survey

  • Used by the Qualaroo client to configure various options.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
    QualarooConfiguration *_Nonnull configuration;

    Swift

    var configuration: QualarooConfiguration { get }

  • The survey will be attached to this position on the current view controller.

    Declaration

    Objective-C

    @property (setter=setPosition:, assign, readwrite, nonatomic)
    QualarooSurveyPosition position;

    Swift

    var position: QualarooSurveyPosition { get set }

  • This style for background will be used on the current view controller.

    Declaration

    Objective-C

    @property (setter=setBlurEffectStyle:, assign, readwrite, nonatomic)
    UIBlurEffectStyle blurEffectStyle;

    Swift

    var blurEffectStyle: Int32 { get set }

  • This transparency for background will be used on the current view controller.

    Declaration

    Objective-C

    @property (setter=setBlurAlpha:, assign, readwrite, nonatomic) CGFloat blurAlpha;

    Swift

    var blurAlpha: CGFloat { get set }

  • Setup the Qualaroo client

    Declaration

    Objective-C

    + (void)setupWithConfiguration:(QualarooConfiguration *_Nonnull)configuration;

    Swift

    class func setup(with configuration: QualarooConfiguration)

    Parameters

    configuration

    The configuration used to setup the client.

  • Attaches Qualaroo’s survey view controller to a given view controller

    Declaration

    Objective-C

    - (BOOL)attachToViewController:(nonnull UIViewController *)viewController
                         error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func attach(toViewController viewController: Any!) throws

    Parameters

    viewController

    The view controller that will be used to host surveys.
    outError

    A pointer to an NSError. In case attach fails, an error will be returned.

  • Attaches Qualaroo’s survey view controller to a given view controller and position

    Declaration

    Objective-C

    - (BOOL)attachToViewController:(nonnull UIViewController *)viewController
                    atPosition:(QualarooSurveyPosition)position
                         error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func attach(toViewController viewController: Any!, at position: QualarooSurveyPosition) throws

    Parameters

    viewController

    The view controller that will be used to host surveys.
    position

    The attachment position only for given view controller
    outError

    A pointer to an NSError. In case attach fails, an error will be returned.

  • Remove a previously attached survey from a view controller.

    Declaration

    Objective-C

    - (void)removeFromViewController;

    Swift

    func removeFromViewController()

  • Display survey with a given alias on a current view controller

    Declaration

    Objective-C

    - (void)showSurveyByAlias:(NSString *_Nonnull)alias
               completion:
                   (BOOL (^_Nullable)(BOOL, NSError *_Nonnull))completion;

    Swift

    func showSurvey(byAlias alias: String, completion: ((Bool, Error) -> Bool)? = nil)

    Parameters

    surveyAlias

    The survey alias to display
    completion

    A block object to be executed when the survey will be ready to show or the survey has some errors. This block has to return Boolean value and takes two arguments. First of these is Boolean value that indicates whether or not the survey ready to display. Second of these is NSError that indicates whether or not the survey has errors.

  • Return the shared Qualaroo client.

    See

    -setupWithConfiguration:

    Declaration

    Objective-C

    + (nonnull instancetype)sharedQualaroo;

    Swift

    class func shared() -> Self

  • Reset any user state that is cached on the device;

    This is useful when a user logs out and you want to clear the identity. It will clear any traits or userId’s cached on the device.

    Declaration

    Objective-C

    - (void)reset;

    Swift

    func reset()

  • Enable the displaying of Qualaroo surveys. Enable by default.

    Declaration

    Objective-C

    - (void)enable;

    Swift

    func enable()

  • Completely disable the displaying of any Qualaroo surveys.

    Declaration

    Objective-C

    - (void)disable;

    Swift

    func disable()

  • Skip current view controller

    Declaration

    Objective-C

    - (void)skip;

    Swift

    func skip()

  • The bundle name.

    Declaration

    Objective-C

    + (nonnull NSString *)name;

    Swift

    class func name() -> String

  • The version of the SDK.

    Declaration

    Objective-C

    + (nonnull NSString *)version;

    Swift

    class func version() -> String

  • The build number of the SDK.

    Declaration

    Objective-C

    + (nonnull NSString *)buildNumber;

    Swift

    class func buildNumber() -> String

  • The build date of the SDK.

    Declaration

    Objective-C

    + (nonnull NSString *)buildDate;

    Swift

    class func buildDate() -> String

  • A description of the SDK build information by combining name, version, build number and build date.

    Declaration

    Objective-C

    + (nonnull NSString *)description;

    Swift

    class func description() -> String