SAPcpmsRecord Class Reference


                      
                      
                      applicationIdentifierKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let applicationIdentifierKey: String


                      
                      
                      applicationVersionKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let applicationVersionKey: String


                      
                      
                      typeKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let typeKey: String


                      
                      
                      durationKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let durationKey: String


                      
                      
                      screenKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let screenKey: String


                      
                      
                      viewKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let viewKey: String


                      
                      
                      elementKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let elementKey: String


                      
                      
                      actionKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let actionKey: String


                      
                      
                      behaviorKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let behaviorKey: String


                      
                      
                      casesKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let casesKey: String


                      
                      
                      categoryKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let categoryKey: String


                      
                      
                      resultKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let resultKey: String


                      
                      
                      unitKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let unitKey: String


                      
                      
                      measurementKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let measurementKey: String


                      
                      
                      valueKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let valueKey: String


                      
                      
                      othersKey

Info key used in the SAPcpmsRecord.

Declaration

Swift

public static let othersKey: String


                      
                      
                      sessionStart(applicationIdentifier:applicationVersion:)

Creates an usage record representing a session start event.

The report will contain:

new session identifier in UUID format
application identifier
application version if there is any
device identifier
deviceModel (such as iPhone)
system name, such as iOS
system version

If the reporter is disabled this method does nothing.

Declaration

Swift

public class func sessionStart(applicationIdentifier: String, applicationVersion: String? = nil) -> UsageRecord


                      
                      
                      sessionEnd()

Creates an usage record representing a session end event.

Declaration

Swift

public class func sessionEnd() -> UsageRecord


                      
                      
                      event(type:key:date:duration:screen:view:element:action:behaviour:case:category:result:unit:measurement:value:others:)

Creates a SAPcpms usage record. All the fields have default values associated with them.

Declaration

Swift

public class func event(type: String? = nil, key: String = "Other", date: Date = Date(), duration: Double? = nil, screen: String? = nil, view: String? = nil, element: String? = nil, action: String? = nil, behaviour: String? = nil, case: String? = nil, category: String? = nil, result: String? = nil, unit: String? = nil, measurement: String? = nil, value: String? = nil, others: Any? = nil) -> UsageRecord

Parameters

`type`	type of the record
`key`	key of the record, default is ‘Other’
`date`	date (time) of the record, default is ‘Date()’
`duration`	duration of the event
`screen`	screen parameter
`view`	view parameter
`element`	element parameter
`action`	action parameter
`behaviour`	behaviour parameter
`case`	case parameter
`category`	category parameter
`result`	result parameter
`unit`	unit parameter
`measurement`	measurement parameter
`value`	value parameter


                      
                      
                      eventStart(type:key:date:duration:screen:view:element:action:behaviour:case:category:result:unit:measurement:value:others:)

Creates a SAPcpms usage record. All the fields have default values associated with them.

Declaration

Swift

public class func eventStart(type: String? = nil, key: String = "Other", date: Date = Date(), duration: Double? = nil, screen: String? = nil, view: String? = nil, element: String? = nil, action: String? = nil, behaviour: String? = nil, case: String? = nil, category: String? = nil, result: String? = nil, unit: String? = nil, measurement: String? = nil, value: String? = nil, others: Any? = nil) -> UsageRecord

Parameters

`type`	type of the record
`key`	key of the record, default is ‘Other’
`date`	date (time) of the record, default is ‘Date()’
`duration`	duration of the event
`screen`	screen parameter
`view`	view parameter
`element`	element parameter
`action`	action parameter
`behaviour`	behaviour parameter
`case`	case parameter
`category`	category parameter
`result`	result parameter
`unit`	unit parameter
`measurement`	measurement parameter
`value`	value parameter


                      
                      
                      eventEnd(type:key:date:duration:screen:view:element:action:behaviour:case:category:result:unit:measurement:value:others:)

Creates a SAPcpms usage record. All the fields have default values associated with them.

Declaration

Swift

public class func eventEnd(type: String? = nil, key: String = "Other", date: Date = Date(), duration: Double? = nil, screen: String? = nil, view: String? = nil, element: String? = nil, action: String? = nil, behaviour: String? = nil, case: String? = nil, category: String? = nil, result: String? = nil, unit: String? = nil, measurement: String? = nil, value: String? = nil, others: Any? = nil) -> UsageRecord

Parameters

`type`	type of the record
`key`	key of the record, default is ‘Other’
`date`	date (time) of the record, default is ‘Date()’
`duration`	duration of the event
`screen`	screen parameter
`view`	view parameter
`element`	element parameter
`action`	action parameter
`behaviour`	behaviour parameter
`case`	case parameter
`category`	category parameter
`result`	result parameter
`unit`	unit parameter
`measurement`	measurement parameter
`value`	value parameter