com.vungle.warren

Interface PlayAdCallback

public interface PlayAdCallback

Callback handler for playing a Vungle advertisement. This is given as a parameter to Vungle.playAd(String, AdConfig, PlayAdCallback) and is triggered when the advertisement begins to play, when the advertisement ends, and when any errors occur.

Method Summary

Modifier and Type	Method and Description
void	onAdEnd(java.lang.String id, boolean completed, boolean isCTAClicked) Callback for an advertisement ending.
void	onAdStart(java.lang.String id) Callback for an advertisement starting.
void	onError(java.lang.String id, java.lang.Throwable error) Callback for an error that has occurred while playing an advertisement.

Method Detail

onAdStart

void onAdStart(java.lang.String id)

Callback for an advertisement starting. The Vungle SDK has successfully launched the advertisement activity and an advertisement will begin playing momentarily.

Parameters:

id - The Placement ID of the advertisement being played.

onAdEnd

void onAdEnd(java.lang.String id,
             boolean completed,
             boolean isCTAClicked)

Callback for an advertisement ending. The Vungle SDK has finished playing the advertisement and the user has closed the advertisement.

Parameters:

id - The Placement ID of the advertisement that ended.

completed - Flag that indicates whether or not the user watched the advertisement to completion.

onError

void onError(java.lang.String id,
             java.lang.Throwable error)

Callback for an error that has occurred while playing an advertisement. If this is called, the error was unrecoverable by the SDK and error handling should happen at the application layer. If this callback is triggered, onAdStart(String) and onAdEnd(String, boolean, boolean) will not be called. This indicates that the advertisement has finished.

Parameters:

id - The identifier for the advertisement placement for which the error occurred.

error - The error that prevented the advertisement from playing.