MarketingCloudSdkConfigBuilder

Class

MarketingCloudSdkConfigBuilder class

Declaration 

1@objc(SFMarketingCloudSdkConfigBuilder)
2public class MarketingCloudSdkConfigBuilder : NSObject
3
4@objc
5public init(appId: String)
6
7@discardableResult
8@objc
9public func setAccessToken(_ accessToken: String) -> MarketingCloudSdkConfigBuilder
10
11@discardableResult
12@objc
13public func setMarketingCloudServerUrl(_ endpoint: URL) -> MarketingCloudSdkConfigBuilder
14
15@discardableResult
16@objc
17public func setMid(_ mid: String) -> MarketingCloudSdkConfigBuilder
18
19@discardableResult
20@objc
21public func setLocationEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
22
23@discardableResult
24@objc
25public func setInboxEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
26
27@discardableResult
28@objc
29public func setAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
30
31@discardableResult
32@objc
33public func setPIAnalyticsEnabled(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
34
35@discardableResult
36@objc
37public func setUseLegacyPIIdentifier(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
38
39@discardableResult
40@objc
41public func setApplicationControlsBadging(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
42
43@discardableResult
44@objc
45public func setDelayRegistrationUntilContactKeyIsSet(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
46
47@discardableResult
48@objc
49public func setEnableScreenEntryTracking(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
50
51@discardableResult
52@objc
53public func setMarkMessageReadOnInboxNotificationOpen(_ enabled: Bool) -> MarketingCloudSdkConfigBuilder
54
55@discardableResult
56@objc
57public func build() -> MarketingCloudSdkConfig

Cases 

init(appId:) 

Initialize MarketingCloudSdkConfigBuilder

1@objc
2public init(appId: String)

setAccessToken(_:) 

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

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

setMarketingCloudServerUrl(_:) 

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

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

setMid(_:) 

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

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

setLocationEnabled(_:) 

Sets the configuration flag that enables or disables location services

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

setInboxEnabled(_:) 

Sets the configuration flag that enables or disables inbox services

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

setAnalyticsEnabled(_:) 

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

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

setPIAnalyticsEnabled(_:) 

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

1@discardableResult
2@objc
3public 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

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

setApplicationControlsBadging(_:) 

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

1@discardableResult
2@objc
3public 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

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

setEnableScreenEntryTracking(_:) 

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

1@discardableResult
2@objc
3public 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.

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

build() 

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

1@discardableResult
2@objc
3public func build() -> MarketingCloudSdkConfig