Engine  12.0.1
Factual's Engine SDK
Instance Methods | List of all members
<FactualEngineDelegate> Protocol Reference

#import <FactualEngineDelegate.h>

Instance Methods

(void) - engineDidStartWithInstance:
 
(void) - engineDidStop
 
(void) - engineDidFailWithError:
 
(void) - engineDidReportInfo:
 
(void) - engineDidSyncWithGarage
 
(void) - engineDidLoadConfig:
 
(void) - engineDidReportDiagnosticMessage:
 
(void) - circumstancesMet:
 

Detailed Description

A general delegate for the sdk.

Method Documentation

◆ circumstancesMet:()

- (void) circumstancesMet: (nonnull NSArray< CircumstanceResponse * > *)  circumstances

Called when one or more user defined circumstances are met. The CircumstanceResponse list only includes responses for circumstances that are met.

Parameters
circumstancesThe circumstances that were met.

◆ engineDidFailWithError:()

- (void) engineDidFailWithError: (nonnull FactualError *)  factualError

Called when an error occurs in the sdk and provides a FactualError.

Parameters
factualErrorThe error that occurred.

◆ engineDidLoadConfig:()

- (void) engineDidLoadConfig: (nonnull FactualConfigMetadata *)  data

Called when a new config is loaded with metadata.

Parameters
dataMetadata about the new config downloaded.

◆ engineDidReportDiagnosticMessage:()

- (void) engineDidReportDiagnosticMessage: (nonnull NSString *)  diagnosticMessage

Called when a structured diagnostic message is available. This diagnostic information can be used to determine if the SDK is working correctly.

Parameters
diagnosticMessageA diagnostic message structured as a JSON string.

◆ engineDidReportInfo:()

- (void) engineDidReportInfo: (nonnull NSString *)  infoMessage

Called when an info message is sent by the sdk.

Parameters
infoMessageThe info message sent by the sdk.

◆ engineDidStartWithInstance:()

- (void) engineDidStartWithInstance: (nonnull FactualEngine *)  engine

Called when the sdk started successfully.

Parameters
engineAn instance of FactualEngine.

◆ engineDidStop()

- (void) engineDidStop

Called when the sdk stopped successfully.

◆ engineDidSyncWithGarage()

- (void) engineDidSyncWithGarage

Called when an on-demand sync with Garage is complete.


The documentation for this protocol was generated from the following file: