XAUserData Class Reference

Inherits from	NSObject
Conforms to	NSCopying
Declared in	XAUserData.h

Overview

User data is optional and can be used to better target an ad when targeting is available for an ad.

Location Data

`– setLocationWithDescription:`

If location of the application user cannot be expressed in coordinates and the general location is known, it can be set with a string description, such as “101 Broad St, City, State” or “City, State”

- (void)setLocationWithDescription:(NSString *)locationDescription

Parameters

`locationDescription`	The location description as a string

Discussion

Declared In

XAUserData.h

Demographic Data

`email`

The email of the current application user

@property (nonatomic, retain) NSString *email

Discussion

The email of the current application user

Declared In

XAUserData.h

`firstName`

The first name of the current application user

@property (nonatomic, retain) NSString *firstName

Discussion

The first name of the current application user

Declared In

XAUserData.h

`lastName`

The last name of the current application user

@property (nonatomic, retain) NSString *lastName

Discussion

The last name of the current application user

Declared In

XAUserData.h

`streetAddress`

The street address of the current application user

@property (nonatomic, retain) NSString *streetAddress

Discussion

The street address of the current application user

Declared In

XAUserData.h

`city`

The city of the current application user

@property (nonatomic, retain) NSString *city

Discussion

The city of the current application user

Declared In

XAUserData.h

`state`

The state of the current application user

@property (nonatomic, retain) NSString *state

Discussion

The state of the current application user

Declared In

XAUserData.h

`zipCode`

The zip code of the current application user

@property (nonatomic, retain) NSString *zipCode

Discussion

The zip code of the current application user

Declared In

XAUserData.h

`county`

The county of the current application user

@property (nonatomic, retain) NSString *county

Discussion

The county of the current application user

Declared In

XAUserData.h

`homePhone`

The home phone of the current application user

@property (nonatomic, retain) NSString *homePhone

Discussion

The home phone of the current application user

Declared In

XAUserData.h

`mobilePhone`

The mobile phone of the current application user

@property (nonatomic, retain) NSString *mobilePhone

Discussion

The mobile phone of the current application user

Declared In

XAUserData.h

`maritalStatus`

The marital status of the current application user

@property (nonatomic, retain) NSString *maritalStatus

Discussion

The marital status of the current application user

Declared In

XAUserData.h

`gender`

The gender of the current application user, either “male” or “female”

@property (nonatomic, retain) NSString *gender

Discussion

The gender of the current application user, either “male” or “female”

Declared In

XAUserData.h

`education`

The education level of the current application user

@property (nonatomic, retain) NSString *education

Discussion

The education level of the current application user

Declared In

XAUserData.h

`children`

The number of children the current user has

@property (nonatomic, retain) NSNumber *children

Discussion

The number of children the current user has

Declared In

XAUserData.h

`ethnicity`

The ethnicity of the application user

@property (nonatomic, retain) NSString *ethnicity

Discussion

The ethnicity of the application user

Declared In

XAUserData.h

`politics`

The political affiliation of the application user

@property (nonatomic, retain) NSString *politics

Discussion

The political affiliation of the application user

Declared In

XAUserData.h

`demographicData`

Holds developer added demographic data as a key value store

@property (nonatomic, retain) NSMutableDictionary *demographicData

Discussion

Holds developer added demographic data as a key value store

Declared In

XAUserData.h

`– addDemographicData:forKey:`

Adds a new peice of demographic data by key.

- (void)addDemographicData:(NSString *)data forKey:(NSString *)key

Parameters

`data`	The demographic data
`key`	The category for the data

Discussion

Adds a new peice of demographic data by key.

Used when demographic data exists that does not fit one of the class properites. Add the data as a key value pair, for example “DOG” and “TRUE” for someone that has a dog.

Declared In

XAUserData.h

`age`

The age of the listener

@property (nonatomic, retain) NSNumber *age

Discussion

The age of the listener

Declared In

XAUserData.h

`birthday`

The birthday of the application user

@property (nonatomic, retain) NSDate *birthday

Discussion

The birthday of the application user

Declared In

XAUserData.h

`– setBirthdayWithMonth:day:year:`

A helper method to set the birthday of the current applicaton user

- (void)setBirthdayWithMonth:(NSInteger)month day:(NSInteger)day year:(NSInteger)year

Parameters

`month`	The month
`day`	The day
`year`	The year

Discussion

A helper method to set the birthday of the current applicaton user

Declared In

XAUserData.h

`– setBirthdayWithAge:`

A helper function to set the birthday of the current application user based on their age

- (void)setBirthdayWithAge:(NSInteger)age

Parameters

`age`	Age of the listener

Discussion

A helper function to set the birthday of the current application user based on their age

Declared In

XAUserData.h

Contextual Data

`– addKeyword:`

Add contextual keywords to the request for the current application context

- (void)addKeyword:(NSString *)keyword

Parameters

`keyword`	A contextual keyword string

Discussion

Add contextual keywords to the request for the current application context

Declared In

XAUserData.h

`– keywordsAsCommaDelimitedString`

Get the keywords as a comma delimited string

- (NSString *)keywordsAsCommaDelimitedString

Return Value

Returns nil if keywords have not been set or the keywords as a comma delimited string

Discussion

Get the keywords as a comma delimited string

Declared In

XAUserData.h