SalesforceAnalytics

SFSDKInstrumentationEvent Class Reference

Inherits from	NSObject
Conforms to	NSCopying
Declared in	SFSDKInstrumentationEvent.h

Other Methods

`eventId`

@property (nonatomic, copy, readonly, nonnull) NSString *eventId

`startTime`

@property (nonatomic, assign, readonly) NSInteger startTime

`endTime`

@property (nonatomic, assign, readonly) NSInteger endTime

`name`

@property (nonatomic, copy, readonly, nonnull) NSString *name

`attributes`

@property (nonatomic, copy, readonly, nullable) NSDictionary *attributes

`sessionId`

@property (nonatomic, copy, readonly, nullable) NSString *sessionId

`sequenceId`

@property (nonatomic, assign, readonly) NSInteger sequenceId

`senderId`

@property (nonatomic, copy, readonly, nullable) NSString *senderId

`senderContext`

@property (nonatomic, copy, readonly, nullable) NSDictionary *senderContext

`schemaType`

@property (nonatomic, assign, readonly) SFASchemaType schemaType

`eventType`

@property (nonatomic, assign, readonly) SFAEventType eventType

`errorType`

@property (nonatomic, assign, readonly) SFAErrorType errorType

`deviceAppAttributes`

@property (nonatomic, strong, readonly, nonnull) SFSDKDeviceAppAttributes *deviceAppAttributes

`connectionType`

@property (nonatomic, copy, readonly, nonnull) NSString *connectionType

`senderParentId`

@property (nonatomic, copy, readonly, nullable) NSString *senderParentId

`sessionStartTime`

@property (nonatomic, assign, readonly) NSInteger sessionStartTime

`page`

@property (nonatomic, copy, readonly, nullable) NSDictionary *page

`previousPage`

@property (nonatomic, copy, readonly, nullable) NSDictionary *previousPage

`marks`

@property (nonatomic, copy, readonly, nullable) NSDictionary *marks

`– initWithJson:`

Parameterized initializer.

- (nonnull instancetype)initWithJson:(nonnull NSData *)jsonRepresentation

Parameters

`jsonRepresentation`	JSON representation.

Return Value

Instance of this class.

Declared In

SFSDKInstrumentationEvent.h

`– jsonRepresentation`

Returns a JSON representation of this event.

- (nonnull NSData *)jsonRepresentation

Return Value

JSON representation.

Declared In

SFSDKInstrumentationEvent.h

`– stringValueOfSchemaType:`

Returns a string representation of schema type.

- (nonnull NSString *)stringValueOfSchemaType:(SFASchemaType)schemaType

Parameters

`schemaType`	Schema type.

Return Value

String representation of schema type.

Declared In

SFSDKInstrumentationEvent.h

`– stringValueOfEventType:`

Returns a string representation of event type.

- (nonnull NSString *)stringValueOfEventType:(SFAEventType)eventType

Parameters

`eventType`	Event type.

Return Value

String representation of event type.

Declared In

SFSDKInstrumentationEvent.h

`– stringValueOfErrorType:`

Returns a string representation of error type.

- (nonnull NSString *)stringValueOfErrorType:(SFAErrorType)errorType

Parameters

`errorType`	Error type.

Return Value

String representation of error type.

Declared In

SFSDKInstrumentationEvent.h

Extension Methods

`– initWithEventId:startTime:endTime:name:attributes:sessionId:sequenceId:senderId:senderContext:schemaType:eventType:errorType:deviceAppAttributes:connectionType:senderParentId:sessionStartTime:page:previousPage:marks:`

Parameterized initializer.

- (nonnull instancetype)initWithEventId:(nonnull NSString *)eventId startTime:(NSInteger)startTime endTime:(NSInteger)endTime name:(nonnull NSString *)name attributes:(nullable NSDictionary *)attributes sessionId:(nullable NSString *)sessionId sequenceId:(NSInteger)sequenceId senderId:(nullable NSString *)senderId senderContext:(nullable NSDictionary *)senderContext schemaType:(SFASchemaType)schemaType eventType:(SFAEventType)eventType errorType:(SFAErrorType)errorType deviceAppAttributes:(nonnull SFSDKDeviceAppAttributes *)deviceAppAttributes connectionType:(nonnull NSString *)connectionType senderParentId:(nullable NSString *)senderParentId sessionStartTime:(NSInteger)sessionStartTime page:(nullable NSDictionary *)page previousPage:(nullable NSDictionary *)previousPage marks:(nullable NSDictionary *)marks

Parameters

`eventId`	Event ID.
`startTime`	Start time.
`endTime`	End time.
`name`	Name.
`attributes`	Attributes.
`sessionId`	Session ID.
`sequenceId`	Sequence ID.
`senderId`	Sender ID.
`senderContext`	Sender context.
`schemaType`	Schema type.
`eventType`	Event type.
`errorType`	Error type.
`deviceAppAttributes`	Device app attributes.
`connectionType`	Connection type.
`senderParentId`	Sender parent ID.
`sessionStartTime`	Session start time.
`page`	Page.
`previousPage`	Previous page.
`marks`	Marks.

Return Value

Instance of this class.

Declared In

SFSDKInstrumentationEvent+Internal.h

`– jsonDictionary`

Returns a JSON dictionary representation of this event.

- (nonnull NSDictionary *)jsonDictionary

Return Value

JSON dictionary representation.

Declared In

SFSDKInstrumentationEvent+Internal.h