XACompanion Protocol Reference

Conforms to NSObject
Declared in XACompanion.h

  clickThrough required method

Action performed when the companion is touched.

@property (nullable, readonly) XAAction *clickThrough

Discussion

Action performed when the companion is touched.

This is only used if the companion cannot provide clickthroughs on its own, such as IFrameResource (not currently supported).

See DAAST 3.2.2.7 for companion tracking details. See DAAST 3.1.5.2 for companion click tracking details.

Declared In

XACompanion.h

  clickTracking required method

An array of URLs that are called when the companion is clicked.

@property (nonnull, readonly) NSArray *clickTracking

Discussion

An array of URLs that are called when the companion is clicked.

See DAAST 3.2.2.7 for companion tracking details. See DAAST 3.1.5.2 for companion click tracking details.

Declared In

XACompanion.h

  trackingEvents required method

An array of tracking events for the companion.

@property (nonnull, readonly) NSArray *trackingEvents

Discussion

An array of tracking events for the companion.

The only event available for tracking is the creativeView event.

See DAAST 3.2.2.7 for companion tracking details.

Declared In

XACompanion.h

  companionResource required method

The companion resource.

@property (nonnull, readonly) NSObject<XACompanionResource> *companionResource

Discussion

The companion resource.

See DAAST 3.2.2.2 for companion resource types.

Declared In

XACompanion.h

  settings required method

The settings for the companion

@property (nonnull) XASettings *settings

Discussion

The settings for the companion

Declared In

XACompanion.h

  visible required method

If the companion is visible to the user.

@property (readonly) BOOL visible

Discussion

If the companion is visible to the user.

Declared In

XACompanion.h

  delegate required method

Delegate object to receive companion events.

@property (nonatomic, retain, nullable, readwrite) NSObject<XACompanionDelegate> *delegate

Discussion

Delegate object to receive companion events.

Declared In

XACompanion.h

+ companionWithClickThrough:clickTracking:trackingEvents:companionResource:settings: required method

Create a companion with a resource and all possible tracking.

+ (nonnull instancetype)companionWithClickThrough:(nullable XAAction *)clickThrough clickTracking:(nullable NSArray *)clickTracking trackingEvents:(nullable NSArray *)trackingEvents companionResource:(nonnull NSObject<XACompanionResource> *)companionResource settings:(nullable XASettings *)settings

Parameters

clickThrough

Action that is performed when the companion is touched
clickTracking

An array of tracking URLs that are fired when the companion is touched
trackingEvents

An array of tracking events for the companion
companionResource

Companion resource
settings

The settings for the companion

Return Value

New companion view

Discussion

Create a companion with a resource and all possible tracking.

Declared In

XACompanion.h

– initWithClickThrough:clickTracking:trackingEvents:companionResource:settings: required method

Create a new companion with click through, tracking, and companion resource.

- (nonnull instancetype)initWithClickThrough:(nullable XAAction *)clickThrough clickTracking:(nullable NSArray *)clickTracking trackingEvents:(nullable NSArray *)trackingEvents companionResource:(nonnull NSObject<XACompanionResource> *)companionResource settings:(nullable XASettings *)settings

Parameters

clickThrough

Action that is performed when the companion is touched
clickTracking

An array of tracking URLs that are fired when the companion is touched
trackingEvents

An array of tracking events for the companion
companionResource

Companion resource
settings

The settings for the companion

Return Value

New companion view

Discussion

Create a new companion with click through, tracking, and companion resource.

Declared In

XACompanion.h