SFMCSdk Class Reference

SFMCSDK Modules

cdp
Declaration
Swift

@objc public static var cdp: CDP


                    
                    
                    personalization

Declaration

Swift

@objc
public static var personalization: PERSONALIZATION


                    
                    
                    identity

Declaration

Swift

@objc
public static let identity: Identity

SFMCSDK Methods


                    
                    
                    initializeSdk(_:completion:)

Declaration

Swift

@objc
public static func initializeSdk(_ configuration: Config, completion: ((_ status: [ModuleInitStatus]) -> Void)? = nil)


                    
                    
                    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()

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?

SDK Getters


                    
                    
                    requestPersonalizationSdk(_:)

Requests the Personalization Module/SDK when it’s operational and safe to use. The provided callback will be invoked when Personalization is ready. The host app shouldn’t normally need to use this, as the Personalization module itself already does this for async operations, like fetching decisions/personalization. As Personalization intentionally doesn’t expose much functionality to the base SFMCSdk, one could use PersonalizationModule.shared within the callback code to use module-specific functionality.

Declaration

Swift

@objc
public static func requestPersonalizationSdk(_ callback: @escaping () -> Void)

Parameters


                                callback

The callback/task to run when Personalization is ready.


                    
                    
                    requestCdpSdk(_:)

Requests the CDP Module/SDK when it’s operational and safe to use. The provided callback will be invoked when CDP Is ready.

Declaration

Swift

@objc
public static func requestCdpSdk(_ callback: @escaping (_ cdp: CdpInterface) -> Void)

Parameters


                                callback

The callback/task to run when CDP is ready.