Available spaces

This sections lists default banner options:

For convenience, there is a list of banner spaces provided through the utility class. It can be used to iterate over all spaces:

util.spaces.forEach(function (space) {
    ext.point(space).extend(/* … */);
});

Extension points

There is a list of extension points defined, which can be used to place banners. All points share a similar API:

ext.point('the/spaces/name').extend({
    cleanup: function (baton) { /* do some cleanup */ },
    draw: function (baton) { /* append baton.data.html to the spaces element, do other stuff */ },
    reload: function (baton) { /* trigger a reload of the banner */ }
    defaults: function (baton) { /* add default values to baton.data, like for sizes or size mappings */ }
});

The following banner spaces are pre-defined:

• io.ox/ads/leaderboard
• io.ox/ads/skyscraper
• io.ox/ads/folder
• io.ox/ads/portalBillboard
• io.ox/ads/mailDetail
• io.ox/ads/mailList
• io.ox/ads/mailSentOverlay
• io.ox/ads/logout

In order to activate one of these spaces, a configuration is necessary.

Default values

The implementation of the banner space extension points provides a defaults method that can be invoked to get some default configuration values. The results will be stored in the data section of a Baton object. The current implementation allows to fetch default sizes and size mappings (mappings of screen space to banner sizes, see GPT documentation for details) for all banner spaces. Those can of course be customized by implementing a custom defaults method for each banner space extension. These sizes contain tested values, which are known to work quite well in AppSuite context.

Example

var defaults = ext.Baton.ensure({
    sizes: [],
    sizeMappings: []
});
ext.point('io.ox/ads/leaderboard').invoke('defaults', undefined, defaults);
console.log(defaults.data.sizes, defaults.data.sizeMappings);

Besides sizes and sizeMappings, many spaces define default values for the showInModules configuration attribute.