bbads_banner_set_placeholder_url()

Set a placeholder image URL for the ad banner.

Synopsis:

#include <bbads/bbads.h>
 

bbads_error_t bbads_banner_set_placeholder_url(bbads_banner_t *banner, const char *placeholder_url)

Since:

BlackBerry 10.0.0

Arguments:

banner

The bbads_banner_t* as created in the call to bbads_banner_create().

placeholder_url

A null-terminated string containing the URL where the placeholder image is located. The placeholder_url must be a local URL and use the "file:///" protocol, for example, "file:///accounts/1000/shared/photos/placeholder_920x60.png". If set to 0, the placeholder URL will not be set for the banner.

Library:

libbbads

Description:

Changing the placeholder image URL can only be performed before the banner has been loaded. See bbads_banner_is_loaded().

The most recent call to this function replaces the previously set placeholder URL.

Setting placeholder_url to 0 removes any previously set placeholder URL.

Note: If a placeholder image URL is not set or if the URL is not a local URL (using the "file:///" protocol), the ad banner will be made completely transparent on a network error event (BBADS_EVENT_NETWORK_ERROR). This will also result in an asynchronous event: BBADS_EVENT_INVISIBLE.

Returns:

  • BBADS_EOK on success.
  • BBADS_EBANNER if the bbads_banner_t* provided is invalid.
  • BBADS_ESTATE if the banner has already been loaded.
  • BBADS_ENOMEM if there isn't enough memory to copy the placeholder URL.
Parent topic: Functions in bbads.h