CISClientSettingProtocol

@protocol CISClientSettingProtocol <NSObject>

Settings for the client instance. This class handles setting for client required parameters Customer Key, Heartbeat Interval & Gateway URL.
The instance of this class is created while creating an instance of class conforming to CISClientSettingProtocol.

  • Required setter for the Conviva account data will be reported to.

    Declaration

    Objective-C

    - (void)setCustomerKey:(NSString *)customerKey;

    Swift

    func setCustomerKey(_ customerKey: String!)

    Parameters

    customerKey

    The Conviva customer key for the Conviva account data should be transferred to.

  • Setter for the time interval at which the Conviva will send available data to the Conviva platform. In seconds, the default value is highly recommended in production environments.

    Declaration

    Objective-C

    - (void)setHeartbeatInterval:(NSTimeInterval)heartbeatInterval;

    Swift

    func setHeartbeatInterval(_ heartbeatInterval: TimeInterval)

    Parameters

    heartbeatInterval

    The time interval for reporting Conviva heartbeat.

  • Setter for the URL of the Conviva platform to report data to. The default value is highly recommended in production environments.

    Declaration

    Objective-C

    - (void)setGatewayUrl:(NSString *)gatewayUrl;

    Swift

    func setGatewayUrl(_ gatewayUrl: String!)

    Parameters

    gatewayUrl

    The URL of the Conviva platform to report data to.

  • Getter for Conviva account customer key.

    Declaration

    Objective-C

    - (NSString *)getCustomerKey;

    Swift

    func getCustomerKey() -> String!

    Return Value

    Customer Key.

  • Getter for heartbeat interval.

    Declaration

    Objective-C

    - (NSTimeInterval)getHeartbeatInterval;

    Swift

    func getHeartbeatInterval() -> TimeInterval

    Return Value

    The time interval for reporting Conviva heartbeat.

  • Getter for gateway URL.

    Declaration

    Objective-C

    - (NSString *)getGatewayUrl;

    Swift

    func getGatewayUrl() -> String!

    Return Value

    The URL of the Conviva platform to report data to.

  • @brief Set user preferences for data collection.

    Declaration

    Objective-C

    - (void)setUserPreferenceForDataCollection:(NSDictionary *)userPrefs;

    Swift

    func setUserPreferenceForDataCollection(_ userPrefs: [AnyHashable : Any]!)

    Parameters

    userPrefs

    pass key value pair as user preferences. Currently Supported keys: “idfa”, “idfv”. Expected Values: YES - Will collect id for mentioned key. NO - Will stop collecting id for mentioned key. Sample Usage: [clientSettings setUserPreferenceForDataCollection:[NSDictionary dictionaryWithObjectsAndKeys: @YES, @“idfa”, @NO, @“idfv”, nil]];

  • @brief Set user preferences for data collection.

    Declaration

    Objective-C

    - (void)setUserPreferenceForDataDeletion:(NSDictionary *)userPrefs;

    Swift

    func setUserPreferenceForDataDeletion(_ userPrefs: [AnyHashable : Any]!)

    Parameters

    userPrefs

    pass key value pair as user preferences. Currently Supported keys: “idfa”, “idfv”. Expected Values: YES - Will stop collecting id for mentioned key and delete previously collected data. NO - Will not have any effect. Sample Usage: [clientSettings setUserPreferenceForDataDeletion:[NSDictionary dictionaryWithObjectsAndKeys: @NO, @“idfa”, @YES, @“idfv”, nil]];