ALEvent Class Reference

Inherits from NSObject
Declared in ALEvent.h

Overview

An object representing an event inside Anyline SDK, with information inside

  image

Image associated with the event (usually from a scan)

@property (nonatomic, readonly, nullable) ALImage *image

Declared In

ALEvent.h

  JSONObject

JSON representation of the event

@property (nonatomic, readonly, nullable) id JSONObject

Declared In

ALEvent.h

  channel

Event channel

@property (nonatomic, copy, nullable) NSString *channel

Declared In

ALEvent.h

  timestamp

Timestamp of an event

@property (nonatomic, readonly) NSDate *timestamp

Declared In

ALEvent.h

  JSONStr

JSON string representation of the event

@property (nonatomic, readonly, nullable) NSString *JSONStr

Declared In

ALEvent.h

+ withJSONObject:image:error:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONObject:(id)JSONObj image:(ALImage *_Nullable)image error:(NSError *_Nullable *_Nullable)error

Parameters

JSONObj

JSON representation of an event
image

image associated with an event
error

an NSError object providing error details with an event

Declared In

ALEvent.h

+ withJSONObject:image:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONObject:(id)JSONObj image:(ALImage *_Nullable)image

Parameters

JSONObj

JSON representation of an event
image

image associated with an event

Declared In

ALEvent.h

+ withJSONObject:error:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONObject:(id)JSONObj error:(NSError *_Nullable *_Nullable)error

Parameters

JSONObj

JSON representation of an event
error

an NSError object providing error details with an event

Declared In

ALEvent.h

+ withJSONObject:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONObject:(id)JSONObj

Parameters

JSONObj

JSON representation of an event

Declared In

ALEvent.h

+ withJSONString:image:error:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONString:(NSString *)JSONString image:(ALImage *_Nullable)image error:(NSError *_Nullable *_Nullable)error

Parameters

JSONString

JSON string representation of an event
image

image associated with an event
error

an NSError object providing error details with an event

Declared In

ALEvent.h

+ withJSONString:error:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONString:(NSString *)JSONString error:(NSError *_Nullable *_Nullable)error

Parameters

JSONString

JSON string representation of an event
error

an NSError object providing error details with an event

Declared In

ALEvent.h

+ withJSONString:image:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONString:(NSString *)JSONString image:(ALImage *_Nullable)image

Parameters

JSONString

JSON string representation of an event
image

image associated with an event

Declared In

ALEvent.h

+ withJSONString:

Create an ALEvent object

+ (ALEvent *_Nullable)withJSONString:(NSString *)JSONString

Parameters

JSONString

JSON string representation of an event

Declared In

ALEvent.h