Classes Reference


                    
                    
                    OMIDAdEvents

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.

Declaration

Objective-C

@interface OMIDAdEvents : NSObject

Swift

class OMIDAdEvents : NSObject


                    
                    
                    OMIDAdSession

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.

Declaration

Objective-C

@interface OMIDAdSession : NSObject

Swift

class OMIDAdSession : NSObject


                    
                    
                    OMIDAdSessionConfiguration

The ad session configuration supplies the owner for both the impression and video events. The OM SDK JS service will use this information to help identify where the source of these events is expected to be received.

Declaration

Objective-C

@interface OMIDAdSessionConfiguration : NSObject

Swift

class OMIDAdSessionConfiguration : NSObject


                    
                    
                    OMIDAdSessionContext

Provides the ad session with details of the partner and whether to an HTML, JavaScript, or native session.

Declaration

Objective-C

@interface OMIDAdSessionContext : NSObject

Swift

class OMIDAdSessionContext : NSObject


                    
                    
                    OMIDJavaScriptSessionService

Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs by providing native-layer measurement signals. If the JS Session Client is running in a web view, an instance of this service must be initialized with the web view before starting or finishing ad sessions using JS APIs. Only one instance of this service may be initialized at a time for a given web view; to reuse a web view the current instance must be torn down (see tearDownWithCompletion).

Declaration

Objective-C

@interface OMIDJavaScriptSessionService : NSObject <WKScriptMessageHandler>

Swift

class OMIDJavaScriptSessionService : NSObject, WKScriptMessageHandler


                    
                    
                    OMIDMediaEvents

This provides a complete list of native media events supported by OMID. Using this event API assumes the media player is fully responsible for communicating all media events at the appropriate times. Only one media events implementation can be associated with the ad session and any attempt to create multiple instances will result in an error.

Declaration

Objective-C

@interface OMIDMediaEvents : NSObject

Swift

class OMIDMediaEvents : NSObject


                    
                    
                    OMIDPartner

Details about the integration partner which will be supplied to the ad session.

Declaration

Objective-C

@interface OMIDPartner : NSObject

Swift

class OMIDPartner : NSObject


                    
                    
                    OMIDSDK

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. Make sure you are on the main thread when you initialize the SDK, create its objects, and invoke its methods.

Declaration

Objective-C

@interface OMIDSDK : NSObject

Swift

class OMIDSDK : NSObject


                    
                    
                    OMIDScriptInjector

Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content.

Declaration

Objective-C

@interface OMIDScriptInjector : NSObject

Swift

class OMIDScriptInjector : NSObject


                    
                    
                    OMIDVASTProperties

This object is used to capture key VAST properties so this can be shared with all registered verification providers.

Declaration

Objective-C

@interface OMIDVASTProperties : NSObject

Swift

class OMIDVASTProperties : NSObject


                    
                    
                    OMIDVerificationScriptResource

Details about the verification provider which will be supplied to the ad session.

Declaration

Objective-C

@interface OMIDVerificationScriptResource : NSObject

Swift

class OMIDVerificationScriptResource : NSObject