Inherits from LUAPIModel : NSObject
Conforms to MKAnnotation
Declared in LULocation.h
LULocation.m

Overview

A LevelUp merchant has one or more locations. Take the example of a chain restaurant with multiple franchises. This restaurant would have a single merchant associated with it, but each store would have its own LULocation.

MapKit

LULocation implements the MKAnnotation protocol. This provides annotation-related information to a map view. The title of the annotation is the result of fullStreetAddress.

Tasks

Properties

categoryIDs

An array of category IDs to which this location belongs.

@property (nonatomic, copy, readonly) NSArray *categoryIDs

Discussion

An array of category IDs to which this location belongs.

Declared In

LULocation.h

descriptionHTML

An HTML string describing the location

@property (nonatomic, copy, readonly) NSString *descriptionHTML

Discussion

An HTML string describing the location

Declared In

LULocation.h

extendedAddress

An optional “extended” address for the location. An example would be an apartment number.

@property (nonatomic, copy, readonly) NSString *extendedAddress

Discussion

An optional “extended” address for the location. An example would be an apartment number.

Declared In

LULocation.h

hours

An optional string representing the hours during which this location is open. The format of this string is determined by the location.

@property (nonatomic, copy, readonly) NSString *hours

Discussion

An optional string representing the hours during which this location is open. The format of this string is determined by the location.

Declared In

LULocation.h

latitude

The latitude of the location.

@property (nonatomic, copy, readonly) NSNumber *latitude

Discussion

The latitude of the location.

Declared In

LULocation.h

locality

The location’s town or city.

@property (nonatomic, copy, readonly) NSString *locality

Discussion

The location’s town or city.

Declared In

LULocation.h

locationID

The unique identifier for this location.

@property (nonatomic, copy, readonly) NSNumber *locationID

Discussion

The unique identifier for this location.

Declared In

LULocation.h

longitude

The longitude of the location.

@property (nonatomic, copy, readonly) NSNumber *longitude

Discussion

The longitude of the location.

Declared In

LULocation.h

merchantID

The ID of this location’s merchant.

@property (nonatomic, copy) NSNumber *merchantID

Discussion

The ID of this location’s merchant.

Declared In

LULocation.h

merchantName

The location’s merchant’s name.

@property (nonatomic, copy) NSString *merchantName

Discussion

The location’s merchant’s name.

Declared In

LULocation.h

name

The location’s name.

@property (nonatomic, copy, readonly) NSString *name

Discussion

The location’s name.

Declared In

LULocation.h

phone

An optional phone number for the location.

@property (nonatomic, copy, readonly) NSString *phone

Discussion

An optional phone number for the location.

Declared In

LULocation.h

postalCode

The location’s postal code.

@property (nonatomic, copy, readonly) NSString *postalCode

Discussion

The location’s postal code.

Declared In

LULocation.h

region

The location’s region, such as a state or province.

@property (nonatomic, copy, readonly) NSString *region

Discussion

The location’s region, such as a state or province.

Declared In

LULocation.h

shown

If shown is set to NO, then this location should not be displayed in-app.

@property (nonatomic, assign) BOOL shown

Discussion

If shown is set to NO, then this location should not be displayed in-app.

Declared In

LULocation.h

streetAddress

The location’s address. If the location’s address has a second line (such as an apartment number), this will be stored separately in the extendedAddress field.

@property (nonatomic, copy, readonly) NSString *streetAddress

Discussion

The location’s address. If the location’s address has a second line (such as an apartment number), this will be stored separately in the extendedAddress field.

Declared In

LULocation.h

summary

Specifies if this instance of LULocation is only a summary. If it is, then only categoryIDs, latitude, locationID, longitude, merchantName, merchantID, shown and updatedAtDate will be set.

@property (nonatomic, assign) BOOL summary

Discussion

Specifies if this instance of LULocation is only a summary. If it is, then only categoryIDs, latitude, locationID, longitude, merchantName, merchantID, shown and updatedAtDate will be set.

Declared In

LULocation.h

updatedAtDate

The time that this location was last changed on the server.

@property (nonatomic, copy) NSDate *updatedAtDate

Discussion

The time that this location was last changed on the server.

Declared In

LULocation.h

webLocations

An instance of LUWebLocations, which holds the associated web locations for this physical location. (Deprecated: This method has been deprecated. Request web links at a location using [LULocationRequestFactory requestForWebLinksAtLocationWithID:].)

@property (nonatomic, copy, readonly) LUWebLocations *webLocations

Discussion

An instance of LUWebLocations, which holds the associated web locations for this physical location.

Declared In

LULocation.h

Instance Methods

fullStreetAddress

If the location has both a streetAddress and an extendedAddress, this will return both values joined by a comma. For example, “123 Main Street, Apt 2A”. When an extendedAddress is not present, only the streetAddress will be returned.

- (NSString *)fullStreetAddress

Discussion

If the location has both a streetAddress and an extendedAddress, this will return both values joined by a comma. For example, “123 Main Street, Apt 2A”. When an extendedAddress is not present, only the streetAddress will be returned.

Declared In

LULocation.h

imageURL

An associated image for the location. Will automatically return a retina or non-retina scaled image based on the screen scale of the device. The resolution is 320x212.

- (NSURL *)imageURL

Discussion

An associated image for the location. Will automatically return a retina or non-retina scaled image based on the screen scale of the device. The resolution is 320x212.

Declared In

LULocation.h

location

A CLLocation instance associated with this location.

- (CLLocation *)location

Discussion

A CLLocation instance associated with this location.

Declared In

LULocation.h

singleLineAddress

A helper method which returns all the address fields in one line. The format is “, locality, region ”. For example: “123 Main Street, Apt 2A, Boston, MA 01234”.

- (NSString *)singleLineAddress

Discussion

A helper method which returns all the address fields in one line. The format is “, locality, region ”. For example: “123 Main Street, Apt 2A, Boston, MA 01234”.

Declared In

LULocation.h