Ad API

The properties below belong to the API object that is passed into a new component when it is loaded into an ad.

Summary
Ad APIThe properties below belong to the API object that is passed into a new component when it is loaded into an ad.
AdAPI Class
Properties
animationAn API for checking if auto initiated actions should run.
environmentAn API for checking environment variables.
expandAn API for activating and deactivating expansions.
factoryA factory for getting new objects like containers, theme, feed parsers, etc.
libraryAn API for retrieving and changing component containers and descriptions.
messageA set of methods for controlling messaging between components.
netA set of methods for controlling network-based actions like linking, sharing, event logging and cookies.
stateAn API for getting and setting the state of a component.
utilAn API containing some utility functions that are useful when writing a component.

AdAPI Class

Summary
Properties
animationAn API for checking if auto initiated actions should run.
environmentAn API for checking environment variables.
expandAn API for activating and deactivating expansions.
factoryA factory for getting new objects like containers, theme, feed parsers, etc.
libraryAn API for retrieving and changing component containers and descriptions.
messageA set of methods for controlling messaging between components.
netA set of methods for controlling network-based actions like linking, sharing, event logging and cookies.
stateAn API for getting and setting the state of a component.
utilAn API containing some utility functions that are useful when writing a component.

Properties

animation

public function get animation():AnimationAPI

An API for checking if auto initiated actions should run.

See animation API for details.

environment

public function get environment():EnvironmentAPI

An API for checking environment variables.

See environment API for details.

expand

public function get expand():ExpandAPI

An API for activating and deactivating expansions.

See expand API for details.

factory

public function get factory():Object

A factory for getting new objects like containers, theme, feed parsers, etc.

See factory API for details.

library

public function get library():LibraryAPI

An API for retrieving and changing component containers and descriptions.

See library API for details.

message

public function get message():MessageAPI

A set of methods for controlling messaging between components.

See message API for details.

net

public function get net():NetAPI

A set of methods for controlling network-based actions like linking, sharing, event logging and cookies.

See net API for details.

state

public function get state():StateAPI

An API for getting and setting the state of a component.

See state API for details.

util

public function get util():UtilAPI

An API containing some utility functions that are useful when writing a component.

See util API for details.

public function get animation():AnimationAPI
An API for checking if auto initiated actions should run.
public function get environment():EnvironmentAPI
An API for checking environment variables.
public function get expand():ExpandAPI
An API for activating and deactivating expansions.
public function get factory():Object
A factory for getting new objects like containers, theme, feed parsers, etc.
public function get library():LibraryAPI
An API for retrieving and changing component containers and descriptions.
public function get message():MessageAPI
A set of methods for controlling messaging between components.
public function get net():NetAPI
A set of methods for controlling network-based actions like linking, sharing, event logging and cookies.
public function get state():StateAPI
An API for getting and setting the state of a component.
public function get util():UtilAPI
An API containing some utility functions that are useful when writing a component.
Close