4.7.0

Example/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - KochavaCoreiOS (4.6.1)
+  - KochavaCoreiOS (4.7.0)
 
 DEPENDENCIES:
   - KochavaCoreiOS (from `../`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  KochavaCoreiOS: f5210a82f87f2d67f40fb066ce895ed69c6a4b5e
+  KochavaCoreiOS: d74f9a00f564ba40e121ae38b62e17f356a062cb
 
 PODFILE CHECKSUM: f5417956eb4d873ce9c7e63ea404070c883eac90
 

KochavaCoreiOS.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'KochavaCoreiOS'
-  s.version          = '4.6.1'
+  s.version          = '4.7.0'
   s.summary          = 'The KochavaCore module of the Kochava iOS SDK.'
 
 # This description is used to generate tags and improve search results.

KochavaCoreiOS/Classes/KVAConfigureWithObjectProtocol.h

@@ -34,9 +34,9 @@
  
  @brief Configures (updates) the instance from another object.
  
- @param withObject An object from which to update the instance.  This is expected to be a native instance, or else an object which can resolve to a native instance.
+ @param withObject An object from which to update the instance.  This is expected to be a JSON dictionary, or alternatively a native instance.
  
- @param context Optional.  The context.
+ @param context The context.
  */
 - (void)kva_configureWith:(nullable id)withObject context:(nullable KVAContext *)context NS_SWIFT_NAME(kva_configure(with:context:));
 

KochavaCoreiOS/Classes/KVAContext.h

@@ -123,7 +123,7 @@
  
  @discussion Examples:  "host", "log", "persistentStorage", "sdk", "server".
  */
-@property (strong, nonatomic, nonnull) NSString *nameString;
+@property (strong, nonatomic, nonnull, readonly) NSString *nameString;
 
 
 

KochavaCoreiOS/Classes/KVAEventSender.h

@@ -49,10 +49,10 @@
 
 
 /*!
-@property events
+ @property events
 
-@brief A property which conforms to protocol KVAEventSender.
-*/
+ @brief A property which conforms to protocol KVAEventSender.
+ */
 @property (strong, nonatomic, nonnull, readonly) id<KVAEventSender> events;
 
 

KochavaCoreiOS/Classes/KVAPartner.h

@@ -29,14 +29,6 @@
 
 
 
-#pragma mark - CLASS
-
-
-
-@class KVAContext;
-
-
-
 #pragma mark - INTERFACE
 
 
@@ -114,17 +106,6 @@
 
 
 
-/*!
- @property shouldPromptDueToBeingNewBool
- 
- @brief A boolean indicating that the user should be prompted due to the partner being newly added.
- 
- @discussion Internal.
- */
-@property BOOL shouldPromptDueToBeingNewBool;
-
-
-
 #pragma mark - GENERAL
 
 
@@ -141,38 +122,12 @@
 
 
 /*!
- @method - didPromptWithDidGrantBoolNumber:date:
- 
- @brief A method for when the host did prompt for consent.
- 
- @discussion Internal.
- 
- @param didGrantBoolNumber The reponse from the user.  A value of true means consent was granted.  A value of false means consent was denied.
- 
- @param date The date attributed to the response.
- */
-- (void)didPromptWithDidGrantBoolNumber:(nullable NSNumber *)didGrantBoolNumber date:(nonnull NSDate *)date NS_SWIFT_NAME(didPrompt(didGrantBoolNumber:date:));
-
+ @method - isGrantedBool
 
+ @brief Returns a boolean indicating if consent is granted.
 
-/*!
- @method - isEffectivelyReferringToTheSamePartner
- 
- @brief Returns a boolean which indicates if two KVAPartner instances effectively refer to the same partner.
- 
- @discussion Internal.
+ @discussion This is a two-state version of isGrantedBoolNumber.  This will return false when isGrantedBoolNumber is nil.
  */
-- (BOOL)isEffectivelyReferringToTheSamePartner:(nullable KVAPartner *)anotherPartner NS_SWIFT_NAME(isEffectivelyReferringToTheSamePartner(_:));
-
-
-
-/*!
-@method - isGrantedBool
-
-@brief Returns a boolean indicating if consent is granted.
-
-@discussion This is a two-state version of isGrantedBoolNumber.  This will return false when isGrantedBoolNumber is nil.
-*/
 - (BOOL)isGrantedBool;
 
 
@@ -210,28 +165,6 @@
 
 
 
-/*!
- @method - shouldPromptBool
- 
- @brief Returns a boolean indicating if this partner raises a need to prompt for consent.
- 
- @discussion Internal.  Compare with shouldBeIncludedInPromptBool.
- */
-- (BOOL)shouldPromptBool;
-
-
-
-/*!
- @method - willPrompt
- 
- @brief Called to indicate that the user will be prompted for consent.
- 
- @discussion Internal.  This is called autiomatically when the willPrompt method on KVAConsent is called.
- */
-- (void)willPrompt;
-
-
-
 @end
 
 

KochavaCoreiOS/Classes/KVAProduct.h

@@ -56,6 +56,58 @@
 
 
 
+#pragma mark - CONSTRUCTORS
+
+
+
+/*!
+ @method + productWithAPIVersionString:buildDateString:bundleIdentifierString:compilerFlagNameStringArray:compilerFlagPredicateSubstitutionVariablesDictionary:nameString:organizationNameString:reverseDomainNameString:versionString:
+ 
+ @brief Constructs an instance of class KVAProduct.
+ 
+ @param apiVersionString An optional API version string.  This property is used to establish API compatibility between products.  API compatibility is assumed to be assured when the value compares to be equal for all products with the same organizationNameString.
+ 
+ @param buildDateString An optional string containing the date when the product was built.  It is recommended that you source this a compile time.  The format is optional, but it is recommended that you provide the date in an ISO 8601 date string.
+ 
+ @param bundleIdentifierString A string containing the bundle identifier associated with this product.  This property may be used to cross-reference this product from a Class.  Logging uses this to take the class for a LogMessage and lookup the associated Product.
+ 
+ @param bundleTypeString The bundle type.  Examples:  "app", "xcframework", "static library".
+ 
+ @param compilerFlagNameStringArray An array containing strings which are the names of compiler flags.
+ 
+ @param compilerFlagPredicateSubstitutionVariablesDictionary A dictionary containing substitution variables for use with an NSPredicate containing compiler flags.
+ 
+ @param moduleNameString The name of the module.  Example:  "KochavaCore".
+ 
+ @param nameString A name string.  Example: "AppleCore".
+ 
+ @param organizationNameString A string containing the name of the organization representing the product.  Example:  "Kochava".
+ 
+ @param reverseDomainNameString A string containing a reverse domain name style representation of the name of the product.  This is used in the definition of keys for persistent storage, dispatch queues, etc.  Example:  "com.kochava.KochavaCore".
+ 
+ @param versionString A version string.
+ 
+ Swift example:
+ @code
+ let product = KVAProduct(
+     apiVersionString: "4",
+     buildDateString: nil,
+     bundleIdentifierString: Bundle(for: type(of: self)).bundleIdentifier,
+     bundleTypeString: "xcframework",
+     compilerFlagNameStringArray: nil,
+     compilerFlagPredicateSubstitutionVariablesDictionary: nil,
+     moduleNameString: "MyModule",
+     nameString: "MyOrganization MyModule",
+     organizationNameString: "My Organization",
+     reverseDomainNameString: "com.myCompany.MyProduct",
+     versionString: "1.0.0"
+ )
+ @endcode
+ */
++ (nonnull instancetype)productWithAPIVersionString:(nullable NSString *)apiVersionString buildDateString:(nullable NSString *)buildDateString bundleIdentifierString:(nullable NSString *)bundleIdentifierString bundleTypeString:(nullable NSString *)bundleTypeString compilerFlagNameStringArray:(nullable NSArray<NSString *> *)compilerFlagNameStringArray compilerFlagPredicateSubstitutionVariablesDictionary:(nullable NSDictionary *)compilerFlagPredicateSubstitutionVariablesDictionary moduleNameString:(nonnull NSString *)moduleNameString nameString:(nonnull NSString *)nameString organizationNameString:(nonnull NSString *)organizationNameString reverseDomainNameString:(nullable NSString *)reverseDomainNameString versionString:(nullable NSString *)versionString;
+
+
+
 #pragma mark - PROPERTIES
 
 
@@ -92,10 +144,10 @@
 /*!
  @property bundleTypeString
 
- @brief The library type.
+ @brief The bundle type.
 
- @discussion Example: "xcframework", "dynamic framework", "static library", "app".
-*/
+ @discussion Examples:  "app", "xcframework", "static library".
+ */
 @property (strong, nonatomic, nonnull, readonly) NSString *bundleTypeString;
 
 
@@ -145,7 +197,7 @@
  
  @brief A name string.
  
- @discussion Example: "KochavaCoreiOS".
+ @discussion Example: "AppleCore".
  */
 @property (strong, nonatomic, nonnull, readonly) NSString *nameString;
 
@@ -231,14 +283,14 @@
 
 
 /*!
-@method - resetWithDeleteLocalDataBool:
+ @method - resetWithDeleteLocalDataBool:
 
-@brief Resets the product.
+ @brief Resets the product.
 
-@discussion This involves resetting variables to their original states.  This may include releasing shared instances.  When parameter deleteLocalDataBool is passed true it also includes erasing any keys from persistent storage which are associated with the product.
+ @discussion This involves resetting variables to their original states.  This may include releasing shared instances.  When parameter deleteLocalDataBool is passed true it also includes erasing any keys from persistent storage which are associated with the product.
  
  @param deleteLocalDataBool A boolean indicating whether or not local data should be deleted.
-*/
+ */
 - (void)resetWithDeleteLocalDataBool:(BOOL)deleteLocalDataBool NS_SWIFT_NAME(reset(deleteLocalDataBool:));
 
 
@@ -251,21 +303,8 @@
  @discussion This can be regarded as being equivalent to performing a reset, but may also include hints to avoid performing automatic behavior consistent with being freshly initialized. 
  
  @param deleteLocalDataBool A boolean indicating whether or not local data should be deleted.
-*/
-- (void)shutdownWithDeleteLocalDataBool:(BOOL)deleteLocalDataBool NS_SWIFT_NAME(shutdown(deleteLocalDataBool:));
-
-
-
-#pragma mark - CLASS GENERAL
-
-
-
-/*!
- @method + productWithAPIVersionString:buildDateString:bundleIdentifierString:compilerFlagNameStringArray:compilerFlagPredicateSubstitutionVariablesDictionary:nameString:organizationNameString:reverseDomainNameString:versionString:
- 
- @brief Creates and returns a product.
  */
-+ (nonnull instancetype)productWithAPIVersionString:(nullable NSString *)apiVersionString buildDateString:(nullable NSString *)buildDateString bundleIdentifierString:(nullable NSString *)bundleIdentifierString bundleTypeString:(nullable NSString *)bundleTypeString compilerFlagNameStringArray:(nullable NSArray<NSString *> *)compilerFlagNameStringArray compilerFlagPredicateSubstitutionVariablesDictionary:(nullable NSDictionary *)compilerFlagPredicateSubstitutionVariablesDictionary moduleNameString:(nonnull NSString *)moduleNameString nameString:(nonnull NSString *)nameString organizationNameString:(nonnull NSString *)organizationNameString reverseDomainNameString:(nullable NSString *)reverseDomainNameString versionString:(nullable NSString *)versionString;
+- (void)shutdownWithDeleteLocalDataBool:(BOOL)deleteLocalDataBool NS_SWIFT_NAME(shutdown(deleteLocalDataBool:));
 
 
 

KochavaCoreiOS/Classes/KVASystem.h

@@ -50,19 +50,19 @@
 
 
 /*!
-@constant messagesAppViewControllerDidBecomeActiveSourceString
+ @constant messagesAppViewControllerDidBecomeActiveSourceString
 
-@brief A constant to use as the source when reporting that a MessagesAppViewController did become active.
-*/
+ @brief A constant to use as the source when reporting that a MessagesAppViewController did become active.
+ */
 @property (class, strong, nonatomic, nonnull, readonly) NSString *messagesAppViewControllerDidBecomeActiveSourceString;
 
 
 
 /*!
-@constant messagesAppViewControllerDidResignActiveSourceString
+ @constant messagesAppViewControllerDidResignActiveSourceString
 
-@brief A constant to use as the source when reporting that a MessagesAppViewController did resign active.
-*/
+ @brief A constant to use as the source when reporting that a MessagesAppViewController did resign active.
+ */
 @property (class, strong, nonatomic, nonnull, readonly) NSString *messagesAppViewControllerDidResignActiveSourceString;
 
 
@@ -118,38 +118,38 @@
 
 
 /*!
-@method - stateActiveDidBecomeWithSourceString:
+ @method - stateActiveDidBecomeWithSourceString:
 
-@brief A method which can be called to report that the active state should become true.
+ @brief A method which can be called to report that the active state should become true.
 
-@discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have become active.
+ @discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have become active.
  
-@param sourceString A string which describes the source that is originating the state change.
-*/
+ @param sourceString A string which describes the source that is originating the state change.
+ */
 - (void)stateActiveDidBecomeWithSourceString:(nonnull NSString *)sourceString;
 
 
 
 /*!
-@method - stateActiveWillResign
+ @method - stateActiveWillResign
 
-@brief A method which can be called to report that the active state should resign true.
+ @brief A method which can be called to report that the active state should resign true.
 
-@discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have resigned active.
-*/
+ @discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have resigned active.
+ */
 - (void)stateActiveWillResign;
 
 
 
 /*!
-@method - stateActiveWillResignWithSourceString:
+ @method - stateActiveWillResignWithSourceString:
 
-@brief A method which can be called to report that the active state should resign true.
+ @brief A method which can be called to report that the active state should resign true.
 
-@discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have resigned active.
+ @discussion Calling this method is generally redundant when the host is an application, as this change is observed automatically.  But this method can and should be called in app extensions, such as iMessage apps, to notify when the state is reported to have resigned active.
  
-@param sourceString A string which describes the source that is originating the state change.
-*/
+ @param sourceString A string which describes the source that is originating the state change.
+ */
 - (void)stateActiveWillResignWithSourceString:(nonnull NSString *)sourceString;