FLBugKit Class Reference
Inherits from | NSObject |
Conforms to | MFMailComposeViewControllerDelegate |
Declared in | FLBugKit.h FLBugKit.m |
Overview
FLBugKit
is a utility for filing bugs via email from within an
application.
It is required that the UIApplicationDelegate
implement the
FLStandardApplicationBugMetadataProtocol
.
When an email for a bug is created a screenshot of the window will be
taken, the FLStandardApplicationBugMetadataProtocol
methods will be called to
gather the bug’s metadata, and if the active view controller implements
the FLAdditionalViewControllerBugMetadataProtocol
its data will be included as well.
FLBugKit
will always include a screenshot, version number (CFBundleShortVersionString),
and build number (CFBundleVersion) in addition to the data returned by
FLStandardApplicationBugMetadataProtocol
and FLAdditionalViewControllerBugMetadataProtocol
.
Tasks
-
+ sharedInstance
Creates and returns the
sharedInstance
ofFLBugKit
. If it already exists it simply returns it. -
– startMonitoringWindow:
Starts monitoring a window for a bug gesture event using the
UIGestureRecognizer
instance provided by the implementation of theFLStandardApplicationBugMetadataProtocol
by thesharedApplication
delegate. -
– stopMonitoringWindow:
Removes the
UIGestureRecognizer
from theUIWindow
that was attached withstartMonitoringWindow:
. -
– presentBugMailerForKeyWindow
Programatically present the bug mailer without waiting for a
UIWindow
gesture recognizer to be raised. ThekeyWindow
for thesharedApplication
will be used to retrieve
Class Methods
sharedInstance
Creates and returns the sharedInstance
of FLBugKit
. If it already
exists it simply returns it.
+ (FLBugKit *)sharedInstance
Return Value
the application’s shared instance of FLBugKit
Discussion
Creates and returns the sharedInstance
of FLBugKit
. If it already
exists it simply returns it.
Declared In
FLBugKit.h
Instance Methods
presentBugMailerForKeyWindow
Programatically present the bug mailer without waiting for a UIWindow
gesture recognizer to be raised. The keyWindow
for the sharedApplication
will be used to retrieve
- (void)presentBugMailerForKeyWindow
Discussion
Programatically present the bug mailer without waiting for a UIWindow
gesture recognizer to be raised. The keyWindow
for the sharedApplication
will be used to retrieve
Declared In
FLBugKit.h
startMonitoringWindow:
Starts monitoring a window for a bug gesture event using the
UIGestureRecognizer
instance provided by the implementation of
the FLStandardApplicationBugMetadataProtocol
by the sharedApplication
delegate.
- (void)startMonitoringWindow:(UIWindow *)window
Parameters
- window
The window instance that will be monitored
Discussion
Starts monitoring a window for a bug gesture event using the
UIGestureRecognizer
instance provided by the implementation of
the FLStandardApplicationBugMetadataProtocol
by the sharedApplication
delegate.
Declared In
FLBugKit.h
stopMonitoringWindow:
Removes the UIGestureRecognizer
from the UIWindow
that was attached
with startMonitoringWindow:
.
- (void)stopMonitoringWindow:(UIWindow *)window
Parameters
- window
The window that will stopped being monitored
Discussion
Removes the UIGestureRecognizer
from the UIWindow
that was attached
with startMonitoringWindow:
.
Declared In
FLBugKit.h