MarketingCloudSdkConfigBuilder

Class

MarketingCloudSdkConfigBuilder class

Declaration

@objc(SFMarketingCloudSdkConfigBuilder)
public class MarketingCloudSdkConfigBuilder : NSObject

@objc
public init(appId: String)

@discardableResult
@objc
public func setAccessToken(_ accessToken: String) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setMarketingCloudServerUrl(_ endpoint: URL) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setMid(_ mid: String) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setLocationEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setInboxEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setPIAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setUseLegacyPIIdentifier(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setApplicationControlsBadging(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setDelayRegistrationUntilContactKeyIsSet(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setEnableScreenEntryTracking(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func setMarkMessageReadOnInboxNotificationOpen(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

@discardableResult
@objc
public func build() -> MarketingCloudSdkConfig

Cases

init(appId:)

Initialize MarketingCloudSdkConfigBuilder

@objc
public init(appId: String)

setAccessToken(_:)

Sets the configuration value to use for the Salesforce MarketingCloud Tenant accessToken.

@discardableResult
@objc
public func setAccessToken(_ accessToken: String) -> MarketingCloudSdkConfigBuilder

setMarketingCloudServerUrl(_:)

Sets the configuration value to use for the Salesforce MarketingCloud Tenant Specific Url.

@discardableResult
@objc
public func setMarketingCloudServerUrl(_ endpoint: URL) -> MarketingCloudSdkConfigBuilder

setMid(_:)

Sets the configuration value to use for the Salesforce MarketingCloud Tenant Specific mid.

@discardableResult
@objc
public func setMid(_ mid: String) -> MarketingCloudSdkConfigBuilder

setLocationEnabled(_:)

Sets the configuration flag that enables or disables location services

@discardableResult
@objc
public func setLocationEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setInboxEnabled(_:)

Sets the configuration flag that enables or disables inbox services

@discardableResult
@objc
public func setInboxEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setAnalyticsEnabled(_:)

Sets the configuration flag that enables or disables Salesforce MarketingCloud Analytics services

@discardableResult
@objc
public func setAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setPIAnalyticsEnabled(_:)

Sets the configuration flag that enables or disables Salesforce Predictive Intelligence analytics services

@discardableResult
@objc
public func setPIAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setUseLegacyPIIdentifier(_:)

Sets the configuration flag that enables or disables Salesforce Predictive Intelligence email override to take contactKey if no value is set

@discardableResult
@objc
public func setUseLegacyPIIdentifier(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setApplicationControlsBadging(_:)

Sets the configuration value which enables or disables application control over badging

@discardableResult
@objc
public func setApplicationControlsBadging(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setDelayRegistrationUntilContactKeyIsSet(_:)

Sets the configuration value which enables or disables application control over delaying SDK registration until a contact key is set

@discardableResult
@objc
public func setDelayRegistrationUntilContactKeyIsSet(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setEnableScreenEntryTracking(_:)

Sets the configuration value which enables or disables the screen entry tracking

@discardableResult
@objc
public func setEnableScreenEntryTracking(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

setMarkMessageReadOnInboxNotificationOpen(_:)

Activates/Deactivates the automatic marking of inbox messages as read when clicking the inbox notification, provided that this configuration is enabled. The default setting for this API is true.

@discardableResult
@objc
public func setMarkMessageReadOnInboxNotificationOpen(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder

build()

Creates a MarketingCloudSdkConfig containing the current builder configuration settings. This can be passed to the ConfigBuilder method(s)

@discardableResult
@objc
public func build() -> MarketingCloudSdkConfig