OOPulsePauseAd

Objective-C

@protocol OOPulsePauseAd <OOPulseAd>

Swift

protocol OOPulsePauseAd : OOPulseAd

This is the protocol for pause ads owned by a OOPulseSession.

This protocol is used to notify the session about events regarding this ad, and provides access to relevant properties.

You must notify this object of the following events:

Depending on your application some of the other methods may need to be called in response to user interaction.

Ad event notifications

  • Notify the session that the ad has been displayed

    This should only be called after your delegate has been instructed to show the ad through -[OOPulseSessionDelegate showPauseAd:].

    Declaration

    Objective-C

    - (void)adDisplayed;

    Swift

    func adDisplayed()

  • Notify the session that the pause ad has been closed by the user.

    Do not call if the ad was closed because the user resumed playback of the video content.

    Declaration

    Objective-C

    - (void)adClosed;

    Swift

    func adClosed()

  • Notify the session that, due to an error, the ad could not be played or that playback could not continue.

    Declaration

    Objective-C

    - (void)adFailedWithError:(OOPulseAdError)error;

    Swift

    func adFailedWithError(_ error: OOPulseAdError)

    Parameters

    error

    The OOPulseAdError that best describes the problem.

Ad properties

  • The MIME-type of the resource to display.

    Declaration

    Objective-C

    - (NSString *)resourceType;

    Swift

    func resourceType() -> String!

  • The URL where the ad’s resource is located.

    Declaration

    Objective-C

    - (NSURL *)resourceURL;

    Swift

    func resourceURL() -> URL!

  • The ad id.

    Declaration

    Objective-C

    - (NSString *)identifier;

    Swift

    func identifier() -> String!

  • The custom ad identifier set in the Ooyala Pulse UI.

    Declaration

    Objective-C

    - (NSString *)customIdentifier;

    Swift

    func customIdentifier() -> String!

  • The Identifier of the advertiser to which the ad belongs.

    Declaration

    Objective-C

    - (NSString *)advertiserIdentifier;

    Swift

    func advertiserIdentifier() -> String!

  • The Identifier of the campaign to which the ad belongs; supplied by Ooyala Pulse.

    Declaration

    Objective-C

    - (NSString *)campaignIdentifier;

    Swift

    func campaignIdentifier() -> String!

  • The custom Identifier of the campaign to which the ad belongs; set in the Ooyala Pulse UI.

    Declaration

    Objective-C

    - (NSString *)customCampaignIdentifier;

    Swift

    func customCampaignIdentifier() -> String!

  • The Identifier of the goal to which the ad belongs; supplied by Ooyala Pulse.

    Declaration

    Objective-C

    - (NSString *)goalIdentifier;

    Swift

    func goalIdentifier() -> String!

  • The custom Identifier of the goal to which the ad belongs; set in the Ooyala Pulse UI.

    Declaration

    Objective-C

    - (NSString *)customGoalIdentifier;

    Swift

    func customGoalIdentifier() -> String!

  • Whether or not the ad is part of an exclusive campaign.

    Declaration

    Objective-C

    - (BOOL)partOfAnExclusiveCampaign;

    Swift

    func partOfAnExclusiveCampaign() -> Bool

  • A string that provides a common name for the ad.

    Declaration

    Objective-C

    - (NSString *)title;

    Swift

    func title() -> String!

  • An array of OOAdCategory objects containing the categories of the Ad and their responsible authorities.

    Declaration

    Objective-C

    - (NSArray *)categories;

    Swift

    func categories() -> [Any]!

  • Returns an array of companion banners for this ad.

    Your application should choose the proper companion banner to display based on their zone identifier.

    Declaration

    Objective-C

    - (NSArray<id<OOPulseCompanionAd>> *)companions;

    Swift

    func companions() -> [Any]!

    Return Value

    A NSArray of objects conforming to the OOPulseCompanionAd protocol.