v4.4.0Previous

Author: J. Doe (https://devcenter.bitrise.io/builds/setting-your-git-credentials-on-build-machines/)

TeadsSDKPrevious.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
 s.name         = "TeadsSDKPrevious"
-s.version      = "4.3.5"
+s.version      = "4.4.0"
 s.summary      = "Teads' iOS SDK"
 
 s.description  = <<-DESC

TeadsSDKPrevious/TeadsSDK.framework/32EF37C3-F5B0-393E-B939-2C054B0145DE.bcsymbolmap renamed to TeadsSDKPrevious/TeadsSDK.framework/0FF28760-0337-3B34-8245-BA0E6FBBE539.bcsymbolmap

@@ -8,24 +8,24 @@
 #import <Foundation/Foundation.h>
 #import "OMIDAdSession.h"
 
-/*!
- * @discussion Ad event API enabling the integration partner to signal to all verification providers when key events have occurred.
+/**
+ *  Ad event API enabling the integration partner to signal to all verification providers when key events have occurred.
  * Only one ad events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error.
  */
 @interface OMIDTeadstvAdEvents : NSObject
 
-/*!
- * @abstract Initializes ad events instance associated with the supplied ad session.
+/**
+ *  Initializes ad events instance associated with the supplied ad session.
  *
  * @param session The ad session associated with the ad events.
  * @return A new ad events instance associated with the supplied ad session. Returns nil if the supplied ad session is nil or if an ad events instance has already been registered with the ad session.
  */
 - (nullable instancetype)initWithAdSession:(nonnull OMIDTeadstvAdSession *)session error:(NSError * _Nullable * _Nullable)error;
 
-/*!
- * @abstract Notifies the ad session that an impression event has occurred.
+/**
+ *  Notifies the ad session that an impression event has occurred.
  *
- * @discussion When triggered all registered verification providers will be notified of this event.
+ *  When triggered all registered verification providers will be notified of this event.
  *
  * NOTE: the ad session will be automatically started if this method has been called first.
  */

TeadsSDKPrevious/TeadsSDK.framework/1804B1EF-FBFB-313A-B6AE-C08EA0269604.bcsymbolmap renamed to TeadsSDKPrevious/TeadsSDK.framework/25B439FE-337A-35BA-904B-ADC7BBA6ECD3.bcsymbolmap

@@ -14,23 +14,23 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
     OMIDErrorVideo = 2 // will translate into "VIDEO" when published to the OMID JS service.
 };
 
-/*!
- * @discussion Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations.
+/**
+ *  Ad session API enabling the integration partner to notify OMID of key state relating to viewability calculations.
  * In addition to viewability this API will also notify all verification providers of key ad session lifecycle events.
  */
 @interface OMIDTeadstvAdSession : NSObject
 
-/*!
- * @abstract The AdSession configuration is used for check owners.
+/**
+ *  The AdSession configuration is used for check owners.
  */
 @property(nonatomic, readonly, nonnull) OMIDTeadstvAdSessionConfiguration *configuration;
-/*!
- * @abstract The native view which is used for viewability tracking.
+/**
+ *  The native view which is used for viewability tracking.
  */
 @property(nonatomic, weak, nullable) UIView *mainAdView;
 
-/*!
- * @abstract Initializes new ad session supplying the context.
+/**
+ *  Initializes new ad session supplying the context.
  *
  * Note that creating an OMIDAdSession sends a message to the OM SDK JS Service running in the
  * webview.  If the OM SDK JS Service has not loaded before the ad session is created, the
@@ -51,17 +51,17 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
                                          error:(NSError *_Nullable *_Nullable)error;
 
 
-/*!
- * @abstract Notifies all verification providers that the ad session has started and ad view tracking will begin.
+/**
+ *  Notifies all verification providers that the ad session has started and ad view tracking will begin.
  * 
- * @discussion This method will have no affect if called after the ad session has finished.
+ *  This method will have no affect if called after the ad session has finished.
  */
 - (void)start;
 
-/*!
- * @abstract Notifies all verification providers that the ad session has finished and all ad view tracking will stop.
+/**
+ *  Notifies all verification providers that the ad session has finished and all ad view tracking will stop.
  *
- * @discussion This method will have no affect if called after the ad session has finished.
+ *  This method will have no affect if called after the ad session has finished.
  *
  * Note that ending an OMID ad session sends a message to the verification scripts running inside
  * the webview supplied by the integration.  So that the verification scripts have enough time to
@@ -70,35 +70,35 @@ typedef NS_ENUM(NSUInteger, OMIDErrorType) {
  */
 - (void)finish;
 
-/*!
- * @abstract Adds friendly obstruction which should then be excluded from all ad session viewability calculations.
+/**
+ *  Adds friendly obstruction which should then be excluded from all ad session viewability calculations.
  *
- * @discussion This method will have no affect if called after the ad session has finished.
+ *  This method will have no affect if called after the ad session has finished.
  *
  * @param friendlyObstruction The view to be excluded from all ad session viewability calculations.
  */
 - (void)addFriendlyObstruction:(nonnull UIView *)friendlyObstruction;
 
-/*!
- * @abstract Removes registered friendly obstruction.
+/**
+ *  Removes registered friendly obstruction.
  *
- * @discussion This method will have no affect if called after the ad session has finished.
+ *  This method will have no affect if called after the ad session has finished.
  *
  * @param friendlyObstruction The view to be removed from the list of registered friendly obstructions.
  */
 - (void)removeFriendlyObstruction:(nonnull UIView *)friendlyObstruction;
 
-/*!
- * @abstract Utility method to remove all registered friendly obstructions.
+/**
+ *  Utility method to remove all registered friendly obstructions.
  *
- * @discussion This method will have no affect if called after the ad session has finished.
+ *  This method will have no affect if called after the ad session has finished.
  */
 - (void)removeAllFriendlyObstructions;
 
-/*!
- * @abstract Notifies the ad session that an error has occurred.
+/**
+ *  Notifies the ad session that an error has occurred.
  *
- * @discussion When triggered all registered verification providers will be notified of this event.
+ *  When triggered all registered verification providers will be notified of this event.
  *
  * @param errorType The type of error.
  * @param message The message containing details of the error.

TeadsSDKPrevious/TeadsSDK.framework/90EFFEB1-A249-32EA-87FA-C148A9AADB99.bcsymbolmap renamed to TeadsSDKPrevious/TeadsSDK.framework/E1B48AF2-191A-369F-80F3-1677D9501FF8.bcsymbolmap

@@ -7,22 +7,35 @@
 
 #import <UIKit/UIKit.h>
 
+/**
+ * Identifies which integration layer is responsible for sending certain events.
+ */
 typedef NS_ENUM(NSUInteger, OMIDOwner) {
-    OMIDJavaScriptOwner = 1, // will translate into "JAVASCRIPT" when published to the OMID JS service.
-    OMIDNativeOwner = 2, // will translate into "NATIVE" when published to the OMID JS service.
-    OMIDNoneOwner = 3 // will translate into "NONE" when published to the OMID JS service.
+    /** The integration will send the event from a JavaScript session script. */
+    OMIDJavaScriptOwner = 1,
+    /** The integration will send the event from the native layer. */
+    OMIDNativeOwner = 2,
+    /** The integration will not send the event. */
+    OMIDNoneOwner = 3
 };
 
+/**
+ * The ad session configuration supplies the owner for both the impression and video events.
+ * The OMID JS service will use this information to help identify where the source of these
+ * events is expected to be received.
+ */
 @interface OMIDTeadstvAdSessionConfiguration : NSObject
 
 @property OMIDOwner impressionOwner;
 @property OMIDOwner videoEventsOwner;
 @property BOOL isolateVerificationScripts;
 
-/// Returns nil and sets error if OMID isn't active or arguments are invalid.
-/// @param impressionOwner providing details of who is responsible for triggering the impression event.
-/// @param videoEventsOwner providing details of who is responsible for triggering video events. This is only required for video ad sessions and should be set to videoEventsOwner:OMIDNoneOwner for display ad sessions.
-/// @param isolateVerificationScripts determines whether verification scripts will be placed in a sandboxed environment. This will not have any effect for native sessions.
+/**
+ * Returns nil and sets error if OMID isn't active or arguments are invalid.
+ * @param impressionOwner providing details of who is responsible for triggering the impression event.
+ * @param videoEventsOwner providing details of who is responsible for triggering video events. This is only required for video ad sessions and should be set to videoEventsOwner:OMIDNoneOwner for display ad sessions.
+ * @param isolateVerificationScripts determines whether verification scripts will be placed in a sandboxed environment. This will not have any effect for native sessions.
+ */
 - (nullable instancetype)initWithImpressionOwner:(OMIDOwner)impressionOwner
                                 videoEventsOwner:(OMIDOwner)videoEventsOwner
                       isolateVerificationScripts:(BOOL)isolateVerificationScripts

TeadsSDKPrevious/TeadsSDK.framework/Headers/OMIDAdEvents.h

@@ -6,17 +6,17 @@
 #import "OMIDPartner.h"
 #import "OMIDVerificationScriptResource.h"
 
-/*!
- * @discussion This class will provide the ad session both details of the partner and whether this is considered HTML or native.
+/**
+ *  This class will provide the ad session both details of the partner and whether this is considered HTML or native.
  */
 @interface OMIDTeadstvAdSessionContext : NSObject
 
 - (null_unspecified instancetype)init NS_UNAVAILABLE;
 
-/*!
- * @abstract Initializes a new ad session context providing reference to partner and web view where OMID JS has been injected.
+/**
+ *  Initializes a new ad session context providing reference to partner and web view where OMID JS has been injected.
  *
- * @discussion Calling this method will set the ad session type to “html”.
+ *  Calling this method will set the ad session type to “html”.
  * <p>
  * NOTE: any attempt to create a new ad session will fail if OMID has not been activated (see {@link OMIDSDK} class for more information).
  *
@@ -30,10 +30,10 @@
                customReferenceIdentifier:(nullable NSString *)customReferenceIdentifier
                                    error:(NSError *_Nullable *_Nullable)error;
 
-/*!
- * @abstract Initializes a new ad session context providing reference to partner and a list of script resources which should be managed by OMID.
+/**
+ *  Initializes a new ad session context providing reference to partner and a list of script resources which should be managed by OMID.
  *
- * @discussion Calling this method will set the ad session type to “native”.
+ *  Calling this method will set the ad session type to “native”.
  * <p>
  * NOTE: any attempt to create a new ad session will fail if OMID has not been activated (see {@link OMIDSDK} class for more information).
  *

TeadsSDKPrevious/TeadsSDK.framework/Headers/OMIDAdSession.h

@@ -7,18 +7,18 @@
 
 #import <Foundation/Foundation.h>
 
-/*!
- * @discussion Details about the integration partner which will be supplied to the ad session.
+/**
+ *  Details about the integration partner which will be supplied to the ad session.
  */
 @interface OMIDTeadstvPartner : NSObject
 
 @property(nonatomic, readonly, nonnull) NSString *name;
 @property(nonatomic, readonly, nonnull) NSString *versionString;
 
-/*!
- * @abstract Initializes new partner instance providing both name and versionString.
+/**
+ *  Initializes new partner instance providing both name and versionString.
  *
- * @discussion Both name and version are mandatory.
+ *  Both name and version are mandatory.
  *
  * @param name It is used to uniquely identify the integration partner.
  * @param versionString It is used to uniquely identify the integration partner.

TeadsSDKPrevious/TeadsSDK.framework/Headers/OMIDAdSessionConfiguration.h

@@ -9,52 +9,55 @@
 
 /// API Note: this value must be copied into the ad SDK's binary. It cannot be an extern defined in
 /// the OMID library.
-#define OMIDSDKAPIVersionString @"{\"v\":\"1.2.1\",\"a\":\"1\"}"
+#define OMIDSDKAPIVersionString @"{\"v\":\"1.2.20\",\"a\":\"1\"}"
 
-/*!
- * @discussion This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods.
+/**
+ *  This application level class will be called by all integration partners to ensure OM SDK has been activated before calling any other API methods.
  * Any attempt to use other API methods prior to activation will result in an error.
  *
- * Note that OM SDK may only be used on the main UI thread.  
+ * Note that OM SDK may only be used on the main UI thread.
  * Make sure you are on the main thread when you initialize the SDK, create its
  * objects, and invoke its methods.
  */
 @interface OMIDTeadstvSDK : NSObject
 
-/*!
- * @abstract The current semantic version of the integrated OMID library.
+/**
+ *  The current semantic version of the integrated OMID library.
  */
 + (nonnull NSString *)versionString;
 
-/*!
- * @abstract Allows the integration partner to check that they are compatible with the running OMID library version.
+/**
+ *  Allows the integration partner to check that they are compatible with the running OMID library version.
  *
  * @param OMIDAPIVersion The version of OMID library integrated by the partner.
  * @return YES if the version supplied is compatible with the integrated OMID library version.
+ *
+ * Note: Planned to be deprecated in next major release
  */
 
 + (BOOL)isCompatibleWithOMIDAPIVersion:(nonnull NSString *)OMIDAPIVersion
 NS_SWIFT_NAME(isCompatible(withOMIDAPIVersion:));
 
-/*!
- * @abstract Shared OMIDSDK instance.
+/**
+ *  Shared OMIDSDK instance.
  */
 @property(class, readonly, nonnull) OMIDTeadstvSDK *sharedInstance
 NS_SWIFT_NAME(shared);
 
-/*!
- * @abstract A Boolean value indicating whether the OMID library has been activated.
+/**
+ *  A Boolean value indicating whether the OMID library has been activated.
  *
- * @discussion The value of this property is YES if the OMID library has already been activated. Allows the integration partner to check that they are compatible with the running OMID library version.
+ *  The value of this property is YES if the OMID library has already been activated. Allows the integration partner to check that they are compatible with the running OMID library version.
  */
 @property(atomic, readonly, getter = isActive) BOOL active;
 
-/*!
- * @abstract Enables the integration partner to activate OMID prior to calling any other API methods.
+/**
+ *  Enables the integration partner to activate OMID prior to calling any other API methods.
  *
  * @param OMIDAPIVersion The version of OMID library integrated by the partner.
  * @param error If an error occurs, contains an NSError object that describes the problem.
  * @return YES if activation was successful when checking the supplied version number for compatibility.
+ *
  */
 - (BOOL)activateWithOMIDAPIVersion:(nonnull NSString *)OMIDAPIVersion
                              error:(NSError *_Nullable *_Nullable)error;