Navmii SDK  2.2.0
Write yourself a navigation system in iOS
Instance Methods | Class Methods | Properties | List of all members
NMExternalRouteHttpRequest Class Reference

Inherits <NSObject>.

Instance Methods

(nonnull instancetype) - NS_UNAVAILABLE
 
(nonnull instancetype) - initWithUrl:
 
(nonnull instancetype) - initWithUrl:body:headers:
 

Class Methods

(nonnull instancetype) + NS_UNAVAILABLE
 
(nonnull instancetype) + requestWithUrl:
 
(nonnull instancetype) + requestWithUrl:body:headers:
 

Properties

NSURL * url
 
NSString * body
 
NSDictionary< NSString *, NSString * > * headers
 

Detailed Description

Interface describing an HTTP request to fetch a route from an external routing server.

Method Documentation

◆ initWithUrl:()

- (nonnull instancetype) initWithUrl: (nonnull NSURL *)  url

Initializes request with the specified URL.

Parameters
url@nonnull The URL of the request.
Returns
An instance of NMExternalRouteHttpRequest.

◆ initWithUrl:body:headers:()

- (nonnull instancetype) initWithUrl: (nonnull NSURL *)  url
body: (nullable NSString *)  body
headers: (nullable NSDictionary< NSString *, NSString * > *)  headers 

Initializes request with the specified URL, body and headers.

Parameters
url@nonnull The URL of the request.
body@nullable The body of the request.
headers@nullable The headers of the request.
Returns
An instance of NMExternalRouteHttpRequest.

◆ NS_UNAVAILABLE() [1/2]

+ (nonnull instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

◆ NS_UNAVAILABLE() [2/2]

- (nonnull instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

◆ requestWithUrl:()

+ (nonnull instancetype) requestWithUrl: (nonnull NSURL *)  url

Creates request with the specified URL.

Parameters
url@nonnull The URL of the request.
Returns
An instance of NMExternalRouteHttpRequest.

◆ requestWithUrl:body:headers:()

+ (nonnull instancetype) requestWithUrl: (nonnull NSURL *)  url
body: (nullable NSString *)  body
headers: (nullable NSDictionary< NSString *, NSString * > *)  headers 

Creates request with specified URL, body and headers.

Parameters
url@nonnull The URL of the request.
body@nullable The body of the request.
headers@nullable The headers of the request.
Returns
An instance of NMExternalRouteHttpRequest.

Property Documentation

◆ body

- (NSString*) body
readnonatomicstrong

The body of the HTTP request.

◆ headers

- (NSDictionary<NSString *, NSString *>*) headers
readnonatomicstrong

The headers of the HTTP request.

◆ url

- (NSURL*) url
readnonatomicstrong

The URL of the HTTP request.