OMIDSDK

@interface OMIDSDK : NSObject

/*
 *  The current semantic version of the integrated OMID library.
 */
+ (nonnull NSString *)versionString;

/*
 *  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:));

/*
 *  Shared OMIDSDK instance.
 */
@property(class, readonly, nonnull) OMIDSDK *sharedInstance
NS_SWIFT_NAME(shared);

/*
 *  A Boolean value indicating whether the OMID library has been activated.
 *
 *  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;

/*
 *  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;

@end

Properties

  • Properties

    Declaration

    Objective-C

    + (nonnull NSString *)versionString;

    Swift

    class func versionString() -> String

  • Properties

    Declaration

    Objective-C

    + (BOOL)isCompatibleWithOMIDAPIVersion:(nonnull NSString *)OMIDAPIVersion
NS_SWIFT_NAME(isCompatible(withOMIDAPIVersion:));

    Swift

    class func isCompatible(withOMIDAPIVersion OMIDAPIVersion: String) -> Bool

  • Properties

    Declaration

    Objective-C

    @property(class, readonly, nonnull) OMIDSDK *sharedInstance

    Swift

    class var shared: OMIDSDK { get }

  • Properties

    Declaration

    Objective-C

    @property(atomic, readonly, getter = isActive) BOOL active

    Swift

    var isActive: Bool { get }

  • Properties

    Declaration

    Objective-C

    - (BOOL)activateWithOMIDAPIVersion:(nonnull NSString *)OMIDAPIVersion
                             error:(NSError *_Nullable *_Nullable)error;

    Swift

    func activate(withOMIDAPIVersion OMIDAPIVersion: String) throws