ForkSDK Class Reference


                    
                    
                    shared

Undocumented

Declaration

Swift

public static let shared: ForkSDK


                    
                    
                    configure(appId:authToken:region:loggers:transformer:)

Configure the minimum deployment target version for the macOS platform.

Declaration

Swift

public func configure(
    appId: String,
    authToken: String,
    region: ForkRegion? = ForkRegion.EU,
    loggers: [ForkLogging]? = nil,
    transformer: ForkTransformerProtocol? = nil
)

Parameters

`appId`	App ID
`authToken`	Application token from ForkSDK console.
`region`	ForkRegion.EU or ForkRegion.US
`loggers`	Optional, Provides a way to pass a class which conforms to ForkLogging interface
`transformer`	Optional, Provides a way to pass a class which conforms to ForkTransformerProtocol interface


                    
                    
                    getAppId()

Retrieves the unique application identifier.

Declaration

Swift

public func getAppId() -> String?


                    
                    
                    getAuthToken()

Undocumented

Declaration

Swift

public func getAuthToken() -> String?


                    
                    
                    setCustomerEndUserId(customerEndUserId:)

Sets the unique end-user identifier.

Declaration

Swift

public func setCustomerEndUserId(customerEndUserId: String)


                    
                    
                    getCustomerEndUserId()

Retrieves the unique end-user identifier.

Declaration

Swift

public func getCustomerEndUserId() -> String?


                    
                    
                    ensurePermissionsAreGranted(for:completion:)

Provide permissions to access iOS HealthKit data. SDK methods will check required permissions and request them if needed.

Declaration

Swift

public func ensurePermissionsAreGranted(
    for dateTypes: Set<ForkDataTypes>, completion: @escaping (Result<Bool, ForkError>) -> Void
)

Parameters

`dateTypes`	Set of required data types ForkDataTypes
`completion`	Callback


                    
                    
                    ensureWritePermissionsAreGranted(for:completion:)

Undocumented

Declaration

Swift

public func ensureWritePermissionsAreGranted(
    for dateTypes: Set<ForkStoreDataTypes>,
    completion: @escaping (Result<Bool, ForkError>) -> Void
)


                    
                    
                    isHealthDataAvailable()

Undocumented

Declaration

Swift

public static func isHealthDataAvailable() -> Bool


                    
                    
                    createConnection(callbackUrl:)

Undocumented

Declaration

Swift

public func createConnection(callbackUrl: String? = nil) -> ForkConnection?


                    
                    
                    getBackgroundConnections()

Undocumented

Declaration

Swift

public func getBackgroundConnections() throws