SFMCSdk Class Reference

SFMCSDK Module Properties

cdp
Declaration
Swift

@objc public static var cdp: CDP
mp
Declaration
Swift

@objc public static var mp: PUSH


                    
                    
                    identity

Declaration

Swift

@objc
public static var identity: IDENTITY


                    
                    
                    sdkVersion

Declaration

Swift

@objc
public static var sdkVersion: String

SFMCSDK Methods


                    
                    
                    initializeSdk(_:)

Declaration

Swift

@objc
public static func initializeSdk(_ configuration: Config)


                    
                    
                    track(event:)

Declaration

Swift

@objc
public static func track(event: Event)


                    
                    
                    state()

Declaration

Swift

@objc
public static func state() -> String

Logger Methods


                    
                    
                    setLogger(logLevel:logOutputter:)

Declaration

Swift

@objc
public static func setLogger(logLevel: LogLevel, logOutputter: LogOutputter? = LogOutputter())


                    
                    
                    setLogger(logLevel:logOutputter:filters:)

Declaration

Swift

public static func setLogger(logLevel: LogLevel, logOutputter: LogOutputter? = LogOutputter(), filters: [LoggerCategory] = [LoggerCategory]())


                    
                    
                    getLogLevel()

Declaration

Swift

@objc
public static func getLogLevel() -> LogLevel


                    
                    
                    clearLoggerFilters()

Declaration

Swift

@objc
public static func clearLoggerFilters()

DataMerge Methods


                    
                    
                    setAutoMergePolicy(onCompletion:)

Declaration

Swift

@objc
public static func setAutoMergePolicy(onCompletion: @escaping AutoMergePolicyCallback)


                    
                    
                    setManualMergePolicy(withHandler:)

Declaration

Swift

@objc
public static func setManualMergePolicy(withHandler handler: @escaping ManualMergePolicyCallback)


                    
                    
                    getDataMergePolicy()

Declaration

Swift

@objc
public static func getDataMergePolicy() -> DataMergePolicy


                    
                    
                    resetDataPolicy(appId:)

Declaration

Swift

@objc
public static func resetDataPolicy(appId: String) -> Bool


                    
                    
                    getAutoDataPolicyCallBack()

Declaration

Swift

@objc
public static func getAutoDataPolicyCallBack() -> AutoMergePolicyCallback?


                    
                    
                    getManualDataPolicyCallBack()

Declaration

Swift

@objc
public static func getManualDataPolicyCallBack() -> ManualMergePolicyCallback?

Keychain Helpers


                    
                    
                    setKeychainAccessibleAttribute(accessibleAttribute:)

Provides a way to set/override the accessibility attribute for Keychain

Declaration

Swift

@available(*, deprecated, message: "This method is obsolete and has been deprecated")
@objc
public static func setKeychainAccessibleAttribute(accessibleAttribute: CFTypeRef?)

Parameters


                                accessibleAttribute

CFTypeRef which has any one of below values kSecAttrAccessibleWhenUnlocked kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly kSecAttrAccessibleWhenUnlockedThisDeviceOnly kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly kSecAttrAccessibleAlwaysThisDeviceOnly


                    
                    
                    keychainAccessibleAttribute()

Returns accessible attribute set by the SDK or overridden value by the consuming application

Declaration

Swift

@available(*, deprecated, message: "This method is obsolete and has been deprecated")
@objc
public static func keychainAccessibleAttribute() -> CFTypeRef?


                    
                    
                    setKeychainAccessErrorsAreFatal(errorsAreFatal:)

Sets whether or not keychain access errors cause a fatal exception.

Declaration

Swift

@available(*, deprecated, message: "This method has no effect, SFMCSdk does not throw fatal exceptions anymore")
@objc
public static func setKeychainAccessErrorsAreFatal(errorsAreFatal: Bool)


                    
                    
                    keychainAccessErrorsAreFatal()

Declaration

Swift

@available(*, deprecated, message: "This method has no effect, SFMCSdk does not throw fatal exceptions anymore")
@objc
public static func keychainAccessErrorsAreFatal() -> Bool

File Protection Helpers


                    
                    
                    setFileProtectionType(fileProtectionType:)

Provides a way to set/override the Protection level for File system

Declaration

Swift

@objc
public static func setFileProtectionType(fileProtectionType: FileProtectionType?)

Parameters


                                fileProtectionType

FileProtectionType which has any one of the below values NSFileProtectionComplete NSFileProtectionCompleteUnlessOpen NSFileProtectionCompleteUntilFirstUserAuthentication NSFileProtectionNone

fileProtectionType()
Returns File protection type set by the SDK or overridden value by the consuming application
Declaration
Swift

@objc public static func fileProtectionType() -> FileProtectionType?


                    
                    
                    requestPushSdk(_:)

Requests the Mobile Push SDK when it’s operational and safe to use. The provided callback will be invoked with the Mobile Push SDK when it’s ready. All push SDK-related API calls should be made within this function.

Declaration

Swift

@objc
public static func requestPushSdk(_ callback: @escaping (_ mp: PushInterface) -> Void)

Parameters


                                callback

A callback that will receive the Mobile Push SDK when it’s operational/ready.