SlyceSDK

Slyce Class Reference

Inherits from	NSObject
Declared in	SlyceInstance.h

`+ shared`

+ (instancetype)shared

`– openWithAccountIdentifier:apiKey:spaceIdentifier:completion:NS_SWIFT_NAME:`

Initializes a new Slyce object using valid Account Identifier, API Key, and Space Identifier.

- (void)openWithAccountIdentifier:(NSString *)accountIdentifier apiKey:(NSString *)apiKey spaceIdentifier:(NSString *)spaceIdentifier completion:(void ( ^ ) ( NSError *_Nullable ))completion NS_SWIFT_NAME

Parameters

`accountIdentifier`	the Account Identifier for your organization.
`apiKey`	the API Key for your organization.
`spaceIdentifier`	the Space Identifier for this SlyceInstance.
`completion`	the completion block. This will always be returned on the main queue. Important: Successfully opening the Slyce object is mandatory before you start performing any tasks in the SDK!

Discussion

Use this method to open the SDK for ‘Public’ recognition functionality. On success, this will also post a SlyceDidOpenNotification.

Declared In

SlyceInstance.h

`credentials`

Returns a SlyceCredentials object if Slyce is authenticated and open. nil otherwise.

@property (nonatomic, readonly, nullable) SlyceCredentials *credentials

Declared In

SlyceInstance.h

`– isOpen`

Returns Slyce “open” status.

- (BOOL)isOpen

Declared In

SlyceInstance.h

`– close`

Closes this instance of Slyce.

- (void)close

Discussion

Posts a SlyceWillCloseNotification before begining to close, and a SlyceDidCloseNotification after close completes.

Declared In

SlyceInstance.h

`defaultSearchParameters`

@property

@property (nonatomic, copy, nullable) SlyceSearchParameters *defaultSearchParameters

Discussion

The SlyceSearchParameters for all requests in this Slyce instance..

Declared In

SlyceInstance.h

`imageMatchingSyncDelegate`

2D catalogs sync delegate

@property (nonatomic, weak, nullable) id<SlyceImageMatchingSyncDelegate> imageMatchingSyncDelegate

Discussion

This object will receive updates about the 2D catalogs sync progress

Declared In

SlyceInstance.h

`analyticsEnabled`

Enables or disables analytics @default YES

@property (nonatomic) BOOL analyticsEnabled

Declared In

SlyceInstance.h

`analyticsShouldIncludeLocationInformation`

Include location information with analytics, if available. @default YES

@property (nonatomic) BOOL analyticsShouldIncludeLocationInformation

Declared In

SlyceInstance.h

`eventTracker`

An instance of SlyceEventTracker for posting events that occur inside of or outside of the SlyceSDK.

@property (nonatomic, readonly) id<SlyceEventTracker> eventTracker

Declared In

SlyceInstance.h

`complianceManager`

An instance of SlyceGDPRComplianceManager for handling GDPR compliance within Slyce.

@property (nonatomic, readonly) SlyceGDPRComplianceManager *complianceManager

Declared In

SlyceInstance.h