AdvertisementEventCreator

public class AdvertisementEventCreator: NSObject

EngageEvent creator for Advertisement playback events

  • Intialize the event creator using specified content id and advertisement id

    Declaration

    Swift

    public init(contentId : String, advertisementId : String)

  • Set the type of the advertisement being shown

    Declaration

    Swift

    public func putAdType(type : String) -> AdvertisementEventCreator

    Parameters

    type

    Type of the advertisement being shown

    Return Value

    AdvertisementEventCreator object after updating the adType

  • Set the total duration of the advertisement being shown

    Declaration

    Swift

    public func putAdDuration(duration : String) -> AdvertisementEventCreator

    Parameters

    type

    duration of the advertisement being shown

    Return Value

    AdvertisementEventCreator object after updating the adDuration

  • Set the progress of the advertisement being shown

    Declaration

    Swift

    public func putAdProgress(type : String) -> AdvertisementEventCreator

    Parameters

    type

    Progress of the advertisement being shown

    Return Value

    AdvertisementEventCreator object after updating the adProgress

  • Creates EngageEvent representing playback start event of the advertisement

    Declaration

    Swift

    public func onAdPlaybackStarted() -> EngageEvent

    Return Value

    EngageEvent representing playback start event of the advertisement

  • Creates EngageEvent representing playback complete event of the advertisement

    Declaration

    Swift

    public func onAdPlaybackCompleted() -> EngageEvent

    Return Value

    EngageEvent representing playback complete event of the advertisement

  • EngageEvent representing playback skip event of the advertisement

    Declaration

    Swift

    public func onAdPlaybackSkipped() -> EngageEvent

    Return Value

    EngageEvent representing playback skip event of the advertisement