TEALVisitorProfile Class Reference
Inherits from | NSObject |
---|---|
Conforms to | NSCoding NSCopying |
Declared in | TEALVisitorProfile.h |
Overview
This class represents a visitor profile retrieved from AudienceStream by the Collect library.
This is meant as a convenience to interact with a profile in a native, typed, safe manner. To access the “raw” profile as was deserialized from the returned JSON use the rawProfile method.
Other Methods
– isValid
Valid flag for Profile instance
- (BOOL)isValid
Return Value
YES if visitorID is valid, otherwise NO
Discussion
Valid flag for Profile instance
Declared In
TEALVisitorProfile.h
– visitorID
Visitor ID addociated with this profile
- (NSString *)visitorID
Return Value
String representation of user’s vistorID
Discussion
Visitor ID addociated with this profile
Declared In
TEALVisitorProfile.h
– audiences
Audiences this visitor’s profile is associated with.
- (NSArray *)audiences
Return Value
Array of TEALVisitorProfileAudienceAttribute objects or nil if none exist
Discussion
Audiences this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– badges
Badges this visitor’s profile is associated with.
- (NSArray *)badges
Return Value
Array of TEALVisitorProfileBadgeAttribute objects or nil if none exist
Discussion
Badges this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– dates
Dates this visitor’s profile is associated with.
- (NSArray *)dates
Return Value
Array of TEALVisitorProfileDateAttribute objects or nil if none exist
Discussion
Dates this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– flags
Flags this visitor’s profile is associated with.
- (NSArray *)flags
Return Value
Array of TEALVisitorProfileFlagAttribute objects or nil if none exist
Discussion
Flags this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– metrics
Metrics this visitor’s profile is associated with.
- (NSArray *)metrics
Return Value
Array of TEALVisitorProfileMetricAttribute objects or nil if none exist
Discussion
Metrics this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– properties
Properties or “Traits” this visitor’s profile is associated with.
- (NSArray *)properties
Return Value
Array of TEALVisitorProfilePropertyAttribute objects or nil if none exist
Discussion
Properties or “Traits” this visitor’s profile is associated with.
Declared In
TEALVisitorProfile.h
– currentVisit
Current visit instance, similar to the TEALVisitorProfile but contains only attributes related to the users current visit.
- (TEALVisitorProfileCurrentVisit *)currentVisit
Return Value
Object representing the visitor profile’s current visit with type TEALVisitorProfileCurrentVisit or nil if current visit has not yet been established.
Discussion
Current visit instance, similar to the TEALVisitorProfile but contains only attributes related to the users current visit.
Declared In
TEALVisitorProfile.h
– rawProfile
Raw profile returned from AudienceStream. JSON object converted to valid native objects
- (NSDictionary *)rawProfile
Return Value
NSDictionary of raw profile objects
Discussion
Raw profile returned from AudienceStream. JSON object converted to valid native objects
Declared In
TEALVisitorProfile.h
PrivateHeader Methods
– initWithVisitorID:
AudienceStream visitor profile object.
- (instancetype)initWithVisitorID:(NSString *)visitorID
Parameters
visitorID |
String unique identifier, currently UUID with “-”’s stripped out. |
---|
Return Value
valid profile object.
Discussion
AudienceStream visitor profile object.
Declared In
TEALVisitorProfile+PrivateHeader.h