Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SDLLocationDetails

SDLLocationDetails Class Reference

Section Contents

Overview

Describes a location, including its coordinate, name, etc. Used in WayPoints.

-initWithCoordinate:

Convenience init for location coordinate.

Objective-C

- (nonnull instancetype)initWithCoordinate:
    (nonnull SDLLocationCoordinate *)coordinate;

Swift

init(coordinate: SDLLocationCoordinate)

Parameters

coordinate

Latitude/Longitude of the location

Return Value

A SDLLocationDetails object

-initWithCoordinate:locationName:addressLines:locationDescription:phoneNumber:locationImage:searchAddress:

Convenience init for all parameters.

Objective-C

- (nonnull instancetype)
     initWithCoordinate:(nonnull SDLLocationCoordinate *)coordinate
           locationName:(nullable NSString *)locationName
           addressLines:(nullable NSArray<NSString *> *)addressLines
    locationDescription:(nullable NSString *)locationDescription
            phoneNumber:(nullable NSString *)phoneNumber
          locationImage:(nullable SDLImage *)locationImage
          searchAddress:(nullable SDLOasisAddress *)searchAddress;

Swift

convenience init(coordinate: SDLLocationCoordinate, locationName: String?, addressLines: [String]?, locationDescription: String?, phoneNumber: String?, locationImage: SDLImage?, search searchAddress: SDLOasisAddress?)

Parameters

coordinate

Latitude/Longitude of the location

locationName

Name of location

addressLines

Location address for display purposes only

locationDescription

Description intended location / establishment

phoneNumber

Phone number of location / establishment

locationImage

Image / icon of intended location

searchAddress

Address to be used by navigation engines for search

Return Value

A SDLLocationDetails object

coordinate

Latitude/Longitude of the location

See

SDLLocationCoordinate

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLLocationCoordinate *coordinate;

Swift

var coordinate: SDLLocationCoordinate? { get set }

locationName

Name of location.

Optional, Max length 500 chars

Objective-C

@property (nonatomic, copy, nullable) NSString *locationName;

Swift

var locationName: String? { get set }

addressLines

Location address for display purposes only.

Optional, Array of Strings, Array length 0 - 4, Max String length 500

Objective-C

@property (nonatomic, copy, nullable) NSArray<NSString *> *addressLines;

Swift

var addressLines: [String]? { get set }

locationDescription

Description intended location / establishment.

Optional, Max length 500 chars

Objective-C

@property (nonatomic, copy, nullable) NSString *locationDescription;

Swift

var locationDescription: String? { get set }

phoneNumber

Phone number of location / establishment.

Optional, Max length 500 chars

Objective-C

@property (nonatomic, copy, nullable) NSString *phoneNumber;

Swift

var phoneNumber: String? { get set }

locationImage

Image / icon of intended location.

See

SDLImage

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLImage *locationImage;

Swift

var locationImage: SDLImage? { get set }

searchAddress

Address to be used by navigation engines for search.

See

SDLOASISAddress

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLOasisAddress *searchAddress;

Swift

var searchAddress: SDLOasisAddress? { get set }
View on GitHub.com
Previous Section Next Section