ClueController

@interface ClueController : NSObject

ClueController is a singleton class and main Clue controller which is also the only public interface for framework user. Here user can turn on/off Clue and start/stop report recording.

  • Returns the shared singleton instance of ClueController

    Declaration

    Objective-C

    + (instancetype)sharedInstance;

    Swift

    class func sharedInstance() -> Self!

    Return Value

    Shared singleton instance of ClueController

  • Start actual recording. You should call this method directly only if you want to start recording with your own custom UI element. It’s recommended to use [ClueController handleShake:]

    Declaration

    Objective-C

    - (void)startRecording;

    Swift

    func startRecording()

  • Stop actual recording. You should call this method directly only if you want to stop recording with your own custom UI element. It’s recommended to use [ClueController handleShake:]

    Declaration

    Objective-C

    - (void)stopRecording;

    Swift

    func stopRecording()

  • Handle shake gesture. Which will start recording if it’s stopped or stop it if it’s recording now

    Declaration

    Objective-C

    - (void)handleShake:(UIEventSubtype)motion;

    Swift

    func handleShake(_ motion: UIEventSubtype)

    Parameters

    motion

    UIEventSubtype motion. This method will activate only with UIEventSubtypeMotionShake events

  • Enable Clue. Recording will start only with enabled Clue

    Declaration

    Objective-C

    - (void)enable;

    Swift

    func enable()

  • Disable Clue. Clue won’t start recording if it’s disabled.

    Declaration

    Objective-C

    - (void)disable;

    Swift

    func disable()

  • Enable Clue with CLUOptions options (like receiver’s email). Recording will start only with enabled Clue

    Declaration

    Objective-C

    - (void)enableWithOptions:(CLUOptions *)options;

    Swift

    func enable(withOptions options: Any!)

    Parameters

    options

    CLUOptions options object which contains configuration properties