IconAd.Companion

public static class IconAd.Companion


Summary

Public methods

static final @NonNull AdLoadResult<@NonNull IconAd>

Loads an IconAd, suspending until an IconAd successfully loads or fails to load.

static final void
load(
    @NonNull IconAdRequest adRequest,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

static final @NonNull Flow<@NonNull AdLoadResult<@NonNull IconAd>>
load(@NonNull IconAdRequest adRequest, int maxNumberOfAds)

Loads multiple IconAds, suspending until maxNumberOfAds loads successfully or fails to load.

static final void
load(
    @NonNull IconAdRequest adRequest,
    int maxNumberOfAds,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

This method is deprecated. Use load(IconAdRequest, Int, IconAdLoadCallback) instead.

static final void
load(
    @NonNull IconAdRequest adRequest,
    int maxNumberOfAds,
    @NonNull IconAdLoadCallback adLoadCallback
)

Loads multiple icon ads asynchronously.

static final void
loadFromAdResponse(
    @NonNull String adResponse,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

Public methods

load

public static final @NonNull AdLoadResult<@NonNull IconAdload(@NonNull IconAdRequest adRequest)

Loads an IconAd, suspending until an IconAd successfully loads or fails to load.

Parameters
@NonNull IconAdRequest adRequest

An IconAdRequest with targeting information.

Returns
@NonNull AdLoadResult<@NonNull IconAd>

AdLoadResult.Success if the load succeeded, AdLoadResult.Failure otherwise.

load

public static final void load(
    @NonNull IconAdRequest adRequest,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

Parameters
@NonNull IconAdRequest adRequest

An IconAdRequest with targeting information.

@NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback

A callback to be invoked when loading completes.

load

public static final @NonNull Flow<@NonNull AdLoadResult<@NonNull IconAd>> load(@NonNull IconAdRequest adRequest, int maxNumberOfAds)

Loads multiple IconAds, suspending until maxNumberOfAds loads successfully or fails to load.

Parameters
@NonNull IconAdRequest adRequest

An IconAdRequest with targeting information.

int maxNumberOfAds

maximum number of ads that are requested to get loaded.

Returns
@NonNull Flow<@NonNull AdLoadResult<@NonNull IconAd>>

A flow that emits AdLoadResult.Success if the load succeeded, AdLoadResult.Failure otherwise.

load

public static final void load(
    @NonNull IconAdRequest adRequest,
    int maxNumberOfAds,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads multiple IconAds, providing the result via adLoadCallback. Invokes adLoadCallback up to maxNumberOfAds times, which may include any combination of the following: AdLoadCallback.onAdLoaded, AdLoadCallback.onAdFailedToLoad.

Use load(IconAdRequest, Int, IconAdLoadCallback) instead.

Parameters
@NonNull IconAdRequest adRequest

An ad request with targeting information.

int maxNumberOfAds

The maximum number of ads to load.

@NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback

A callback to be invoked when loading completes.

load

public static final void load(
    @NonNull IconAdRequest adRequest,
    int maxNumberOfAds,
    @NonNull IconAdLoadCallback adLoadCallback
)

Loads multiple icon ads asynchronously. Each ad load attempt triggers a callback to either IconAdLoadCallback.onAdLoaded or IconAdLoadCallback.onAdFailedToLoad. Once all ad requests have completed (regardless of success or failure), IconAdLoadCallback.onAdLoadingCompleted is invoked.

Parameters
@NonNull IconAdRequest adRequest

An ad request with targeting information.

int maxNumberOfAds

The maximum number of ads to load.

@NonNull IconAdLoadCallback adLoadCallback

A callback to be invoked when loading completes.

loadFromAdResponse

public static final void loadFromAdResponse(
    @NonNull String adResponse,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

Parameters
@NonNull String adResponse

An ad response from a server-to-server ad request.

@NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback

A callback to be invoked when loading completes.