WS1Intelligence

Initialization¶

enable¶

Initializes Workspace ONE Intelligence SDK. This method will use the app ID string value specified in the application’s 'info.plist' file with the key ‘WS1IntelligenceAppID’

Declaration

Objective-C

+ (void)enable

Swift

class func enable()

enableWithConfig:¶

Initializes Workspace ONE Intelligence SDK with a config. This method will use the app ID string value specified in the application’s 'info.plist' file with the key ‘WS1IntelligenceAppID’ After this call completes, changes to the config object will have no affect on the behavior of Workspace ONE Intelligence SDK.

Declaration

Objective-C

+ (void)enableWithConfig:(WS1Config *)config

Swift

class func enable(withConfig: config)

Parameters

enableWithAppID:¶

Initializes Workspace ONE Intelligence SDK with the given App ID (found on the Workspace ONE Intelligence web portal).

Declaration

Objective-C

+ (void)enableWithAppID:(NSString *)appId
class func enable(withAppID: appID)

Parameters

enableWithAppID:config:¶

Initializes Workspace ONE Intelligence SDK with the given App ID (found on the Workspace ONE Intelligence web portal). After this call completes, changes to the config object will have no affect on the behavior of Workspace ONE Intelligence SDK.

Declaration

Objective-C

+ (void)enableWithAppID:(NSString *)appId config:(WS1Config *)config

Swift

class func enable(withAppID: appID,
                     config: ws1Config)

Parameters

Logging Breadcrumbs¶

A breadcrumb is a developer-defined text string (up to 140 characters) that allows developers to capture app run-time information. Example breadcrumbs may include variable values, progress through the code, user actions, or low memory warnings. For an introduction, see Breadcrums Overview.

leaveBreadcrumb:¶

Breadcrumbs provide the ability to track activity within your app. A breadcrumb is a free form string you supply, which will be timestamped. Crash events, or other events, may refer to these for additional diagnostic details.

Breadcrumbs are limited to 140 characters.

Declaration

Objective-C

+ (void)leaveBreadcrumb:(NSString *)breadcrumb

Swift

class func leaveBreadcrumb(breadcrumb: String)

Parameters

setAsyncBreadcrumbMode:¶

By default, breadcrumbs are flushed to disk immediately when written. This is by design - in order to provide an accurate record of everything that happened up until the point your app crashed. To improve performance you can instruct the library to perform all breadcrumb writes on a background thread. This means that breadcrums are not guaranteed to be saved immediately prior to a crash.

Declaration

Objective-C

+ (void)setAsyncBreadcrumbMode:(BOOL)writeAsync

Swift

class func setAsyncBreadcrumbMode(writeAsync: Bool)

Parameters

See also Breadcrums Overview.

Logging Errors and Handled Exceptions¶

logError:¶

Logging errors is a way of reporting NSError errors your app has received. If the method is passed an NSError, the stack trace of the thread that is logging the error will be displayed on the Crittercism web portal.

Logging errors may also be used for tracking NSError errors returned by Apple methods and 3rd party library errors. Errors are grouped by stacktrace, much like crash reports. Errors may be viewed in the “Handled Exceptions” area of the Workspace ONE Intelligence portal.

Declaration

Objective-C

+ (BOOL)logError:(NSError *)error;

Swift

class func logError(error: Error)

Parameters

logError:stacktrace:¶

Logging errors is a way of reporting NSError errors your app has received. If the method is passed an NSError, the stack trace of the thread that is logging the error will be displayed on the Crittercism web portal.

Logging errors may also be used for tracking NSError errors returned by Apple methods and 3rd party library errors. Errors are grouped by stacktrace, much like crash reports. Errors may be viewed in the “Handled Exceptions” area of the Workspace ONE Intelligence portal.

Declaration

Objective-C

+ (BOOL)logError:(NSError *)error stacktrace:(NSArray *)stacktrace;

Swift

class func logError(error: Error stacktrace: Stacktrace)

Parameters

This capability was introduced in SDK v5.9.1

logHandledException:¶

Handled exceptions may be used for tracking exceptions caught in a try/catch statement, 3rd party library exceptions, and monitoring areas in the code that may currently be using assertions. Handled exceptions can also be used to track error events such as low memory warnings. For an introduction, see Handled Exceptions.

Handled exceptions are grouped by stacktrace, much like crash reports. Handled exceptions may be viewed in the “Handled Exceptions” area of the Workspace ONE Intelligence portal.

Declaration

Objective-C

+ (BOOL)logHandledException:(NSException *)exception

Swift

class func logHandledException(exception: NSException)

Parameters

See also Introduction to Handled Exception.

Logging Network Request¶

Network Insights data for NSURLSession and NSURLConnection is automatically captured and reported to Workspace ONE Intelligence simply by initializing the SDK. See Network Insights.

If you want to log network requests manually or customize what data gets reported, use these methods.

addFilter:¶

Adds an additional filter for network instrumentation.

Declaration

Objective-C

+ (void)addFilter:(WS1Filter *)filter

Swift

class func add(filter: WS1Filter)

Parameters

logNetworkRequest:url:latency:bytesRead:bytesSent:responseCode:error:¶

Logging endpoints is a way of manually logging Network Insights data for custom network libraries which fall outside Workspace ONE Intelligence’s monitoring of NSURLConnection and NSURLSession method calls.

Declaration

Objective-C

+ (BOOL)logNetworkRequest:(NSString *)method
                      url:(NSURL *)url
                  latency:(NSTimeInterval)latency
                bytesRead:(NSUInteger)bytesRead
                bytesSent:(NSUInteger)bytesSent
             responseCode:(NSInteger)responseCode
                    error:(NSError *)error

Swift

class func logNetworkRequest(method: String,
                            url url: NSURL,
                    latency latency: NSTimeInterval,
                bytesRead bytesRead: Int,
                bytesSent bytesSent: Int,
          responseCode responseCode: Int,
                        error error: NSError) -> Bool

Parameters

Returns YES if the request was properly logged. Returns NO otherwise.

See also:

• Network Insights
• Network Insights Best Practices

logNetworkRequest:urlString:latency:bytesRead:bytesSent:responseCode:error:¶

Logging endpoints is a way of manually logging Network Insights data for custom network libraries which fall outside Workspace ONE Intelligence’s monitoring of NSURLConnection and NSURLSession method calls.

Declaration

Objective-C

+ (BOOL)logNetworkRequest:(NSString *)method
                urlString:(NSString *)urlString
                  latency:(NSTimeInterval)latency
                bytesRead:(NSUInteger)bytesRead
                bytesSent:(NSUInteger)bytesSent
             responseCode:(NSInteger)responseCode
                    error:(NSError *)error

Swift

class func logNetworkRequest(method: String,
                urlString urlString: NSString,
                    latency latency: NSTimeInterval,
                bytesRead bytesRead: Int,
                bytesSent bytesSent: Int,
          responseCode responseCode: Int,
                        error error: NSError) -> Bool

Parameters

Returns YES if the request was properly logged. Returns NO otherwise.

updateLocationToLatitude:longitude:¶

Inform Workspace ONE Intelligence SDK of the device’s most recent location for use with event reporting.

Declaration

Objective-C

+ (void)updateLocationToLatitude:(double)location longitude:(double)longitude

Swift

class func updateLocation(toLatitude: double, longitude: double)

Parameters

This capability was introduced in SDK v5.9.3.

Setting Username¶

This interface sets a relationship between a provided username string and the device UUID.

setUsername:¶

Declaration

Objective-C

+ (void)setUsername:(NSString *)username

Swift

class func setUsername(username: String)

Parameters

Logging User Flows¶

User flows allow developers to track key interactions or user flows in their app such as login, account registration, and in app purchase.

For an introduction, see User Flows Monitoring.

beginUserFlow:¶

Inititializes and begins a user flow

User flows allow developers to track key interactions or user flows in their app such as login, account registration, and in app purchase. The Workspace ONE Intelligence SDK will automatically track application load time as a user flow. You can specify additional user flows by adding code to your application.

Beginning a user flow starts a user flow. Ending, failing, or cancelling a user flow stops a user flow. Otherwise, the user flow will be marked as crashed or timed out. If a crash occurs, all in progress user flows are marked crashed and will be reported with the crash.

All user flows will appear on Workspace ONE Intelligence portal except for cancelled user flows.

User flows with the same name are aggregated together in the portal by Workspace ONE Intelligence. Only one user flow for a given name can be in progress at a given time. If you begin a second user flow with the same name while another is in progress, the first user flow will be cancelled and the new one will take its place.

Declaration

Objective-C

+ (void)beginUserFlow:(NSString *)name

Swift

class func beginUserFlow(name: String)

Parameters

See also:

• Introduction to User Flows
• Three Ways to Improve User Experience through User Flows
• Tracking User Experience with Advanced User Flows

beginUserFlow:timeout:¶

Inititializes and begins a user flow with a specified timeout. If the user flow is not otherwise completed before this time elapses, the user flow will be marked as timed out.

User flows allow developers to track key interactions or user flows in their app such as login, account registration, and in app purchase. The Workspace ONE Intelligence SDK will automatically track application load time as a user flow. You can specify additional user flows by adding code to your application.

Beginning a user flow starts a user flow. Ending, failing, or cancelling a user flow stops a user flow. Otherwise, the user flow will be marked as crashed or timed out. If a crash occurs, all in progress user flows are marked crashed and will be reported with the crash.

All user flows will appear on Workspace ONE Intelligence portal except for cancelled user flows.

User flows with the same name are aggregated together in the portal by Workspace ONE Intelligence. Only one user flow for a given name can be in progress at a given time. If you begin a second user flow with the same name while another is in progress, the first user flow will be cancelled and the new one will take its place.

Declaration

Objective-C

+ (void)beginUserFlow:(NSString *)name
              timeout:(NSTimeInterval)timeout

Swift

class func beginUserFlow(name: String timeout: TimeInterval)

Parameters

See also:

• Introduction to User Flows
• Three Ways to Improve User Experience through User Flows
• Tracking User Experience with Advanced User Flows

cancelUserFlow:¶

Cancel a user flow as if it never existed. The user flow will not be reported.

Declaration

Objective-C

+ (void)cancelUserFlow:(NSString *)name

Swift

class func cancelUserFlow(name: String)

Parameters

endUserFlow:¶

End an already begun user flow successfully.

Declaration

Objective-C

+ (void)endUserFlow:(NSString *)name

Swift

class func endUserFlow(name: String)

Parameters

failUserFlow:¶

End an already begun user flow as a failure.

Declaration

Objective-C

+ (void)failUserFlow:(NSString *)name

Swift

class func failUserFlow(name: String)

Parameters

Detecting a Crash Occurred¶

You can listen to WS1NotificationDidCrashOnLastLoad to get more app crash information on the previous run.

didCrashOnLastLoad:¶

Declaration

Objective-C

+ (BOOL)didCrashOnLastLoad

Swift

class func didCrashOnLastLoad -> Bool

Returns YES if the app crashed on the last load, returns NO otherwise.

See also:

• WS1NotificationDidCrashOnLastLoad
• Last Crash UserInfo Keys

Opt In Status¶

Workspace ONE Intelligence SDK provides an opt-in settings API that can enable or disable reporting for the Workspace ONE Intelligence features and can enable or disable reporting for the DEX feature. Each feature can be controlled individually. Note that each feature can have different default settings.

This allows developers to implement code that allows end users to decide which reporting features they want to enable for Workspace ONE Intelligence.

For an introduction, see Opt Out of Workspace ONE Intelligence.

getOptInStatusForType¶

Returns the current Opt-In status for the specified telemetry instrumentation type.

Declaration

Objective-C

typedef NS_ENUM(NSInteger, WS1TelemetryType) {
     WS1TelemetryTypeApplication = 0,
     WS1TelemetryTypeDEX,
};

/*! 
 * @param type Application or DEX
 */
+ (BOOL)getOptInStatusForType:(WS1TelemetryType)type;

Swift

class func getOptInStatus(for: WS1TelemetryType) -> Bool

Parameters

Returns

Return YES (true) if the specified telemetry instrumentation type is opted in.

setOptInStatusForType:andStatus:¶

If you wish to offer your users the ability to opt in or out of Workspace ONE Intelligence data reporting, you can provide a user interface, then set the OptInStatus for them. If OptInStatus is set to false, there will be no information/requests sent from that user's app and any pending crash reports will be purged.

Typically, a developer would connect this API call to a checkbox in a settings menu.

Likewise, you can set this from another configuration source, such as MDM settings.

Declaration

Objective-C

/*! Sets the Opt-In status for telemetry instrumentations, currently the two
* options are Application or DEX. Setting a telemetry instrumentation Opt-In to YES enables the
* collection of telemetry data.
* The default for Application is YES
* The default for DEX is NO
* @param type `Application` or `DEX`
* @param status new Opt-In status
*/
+ (void)setOptInStatusForType:(WS1TelemetryType)type andStatus:(BOOL)status;

Swift

class func setOptInStatusFor(type: WS1TelemetryType, andStatus: Bool)

Parameters

getOptOutStatus (deprecated)¶

Retrieve current opt out status.

Declaration

Objective-C

+ (BOOL)getOptOutStatus

Swift

class func getOptOutStatus -> Bool

Return YES if the user has opted out of reporting Workspace ONE Intelligence data.

setOptOutStatus: (deprecated)¶

If you wish to offer your users the ability to opt out of Workspace ONE Intelligence data reporting, you can set the OptOutStatus to YES. If you do so, there will be no information/requests sent from that user’s app and any pending crash reports will be purged.

Typically, a developer would connect this API call to a checkbox in a settings menu.

Declaration

Objective-C

+ (void)setOptOutStatus:(BOOL)status

Swift

class func setOptOutStatus(status: Bool)

Parameters

Setting Log Verbosity Of Workspace ONE Intelligence SDK¶

loggingLevel¶

Declaration

Objective-C

+ (WS1IntelligenceLoggingLevel)loggingLevel

Swift

class func loggingLevel() -> WS1IntelligenceLoggingLevel

The current logging level of the verbosity of Workspace ONE Intelligence SDK log messages.

setLoggingLevel:¶

Set the logging level to tune the verbosity log messages from Workspace ONE Intelligence SDK. The default value is WS1IntelligenceLoggingLevelWarning.

See WS1IntelligenceLoggingLevel to see various logging levels.

Declaration

Objective-C

+ (void)setLoggingLevel:(WS1IntelligenceLoggingLevel)loggingLevel

Swift

class func setLoggingLevel(loggingLevel: WS1IntelligenceLoggingLevel)

Parameters

Workspace ONE Intelligence SDK Device UUID¶

getUserUUID¶

Get the unique identifier for this device generated by Workspace ONE Intelligence SDK. This is NOT the device’s UDID.

If called before enabling the SDK, this will return an empty string.

If a Workspace ONE Intelligence SDK enabled app is removed from a device, a new UUID will be generated when the next app is installed.

Declaration

Objective-C

+ (NSString *)getUserUUID

Swift

class func getUserUUID -> String