iOS Verizon Ads SDK Standard Edition Documentation  1.14
Instance Methods | Properties | List of all members
VASRequestMetadata Class Reference

VASRequestMetadata is the metadata that is included with an ad or bid request. More...

#import <VASRequestMetadata.h>

Inherits NSObject, and <NSCopying>.

Instance Methods

(id- copyWithZone:
 Perform a deep copy. More...
 
(instancetype) - initWithAppData:userData:placementData:extras:supportedOrientations:
 Initialize with read-only properties. More...
 
(BOOL- isEqualToRequestMetadata:
 Indicates whether the contents of the receiving RequestMetadata are equal to the contents of another given instance. More...
 

Properties

NSDictionary< NSString *, id > * appData
 Application metadata (e.g., mediator).
 
NSDictionary< NSString *, id< NSCopying > > * extras
 Extra metadata (e.g., impression groups).
 
NSDictionary< NSString *, id > * placementData
 Placement metadata (e.g. placementId, adSize).
 
NSArray< NSString * > * supportedOrientations
 Supported orientations.
 
NSDictionary< NSString *, id > * userData
 User metadata (e.g., age, dob, gender).
 

Detailed Description

VASRequestMetadata is the metadata that is included with an ad or bid request.

Note that this class is an immutable container and its properties cannot be changed. To change metadata, simply create another instance with the new data, copying anything that hasn't changed.

Method Documentation

◆ copyWithZone:

- (id) copyWithZone: (nullable NSZone *)  zone

Perform a deep copy.

Parameters
zoneZone to use for the copy.
Returns
An immutable copy of this class.

◆ initWithAppData:userData:placementData:extras:supportedOrientations:

- (instancetype) initWithAppData: (nullable NSDictionary< NSString *, id > *)  appData
userData: (nullable NSDictionary< NSString *, id > *)  userData
placementData: (nullable NSDictionary< NSString *, id > *)  placementData
extras: (nullable NSDictionary< NSString *, id< NSCopying >> *)  extras
supportedOrientations: (nullable NSArray< NSString * > *)  supportedOrientations 

Initialize with read-only properties.

All properties are copied into immutable equivalents.

Parameters
appDataApplication metadata (e.g., mediator).
userDataUser metadata (e.g., age, dob, gender).
placementDataPlacement metadata (e.g. placementId, adSize).
extrasExtra metadata (e.g., impression groups).
supportedOrientationsSupported orientations.
Returns
An initialized instance of this class.

◆ isEqualToRequestMetadata:

- (BOOL) isEqualToRequestMetadata: (VASRequestMetadata *)  otherRequestMetadata

Indicates whether the contents of the receiving RequestMetadata are equal to the contents of another given instance.

Parameters
otherRequestMetadataOther instance to test.
Returns
YES if the contents of this instance is equal to the other, NO otherwise.