W3wIOSSDK Class Reference

Inherits from NSObject
Declared in W3wIOSSDK.h

Overview

The what3words iOS SDK

– forwardGeocode:

Forward geocodes a valid 3 word address to coordinates and associated metadata

- (W3wPosition *)forwardGeocode:(NSString *)threeWordAddress

Parameters

threeWordAddress

String containing exactly 3 words representing a valid 3 word address with a period separator

Return Value

A W3wPosition instance containing the 3 word address, its coordinates, bounding box and language code or nil if no result found

Discussion

Forward geocodes a valid 3 word address to coordinates and associated metadata

Declared In

W3wIOSSDK.h

– forwardGeocode:outputLanguage:

Forward geocodes a valid 3 word address to coordinates and associated metadata

- (W3wPosition *)forwardGeocode:(NSString *)threeWordAddress outputLanguage:(NSString *)language

Parameters

threeWordAddress

String containing exactly 3 words representing a valid 3 word address with a period separator

language

A supported 3 word address language as an ISO 639-1 2 letter code

Return Value

A W3wPosition instance containing the 3 word address, its coordinates, bounding box and language code or nil if no result found

Discussion

Forward geocodes a valid 3 word address to coordinates and associated metadata

Declared In

W3wIOSSDK.h

– reverseGeocode:language:

Reverse geocodes a set of coordinates to a 3 word address, displayed according to the specified language.

- (W3wPosition *)reverseGeocode:(W3wLatLng *)latLng language:(NSString *)language

Parameters

latLng

W3wLatLng containing the coordinates to be reverse geocoded

language

A supported 3 word address language as an ISO 639-1 2 letter code

Return Value

A W3wPosition instance containing the 3 word address, its coordinates, bounding box and language code or nil if no result found

Discussion

Reverse geocodes a set of coordinates to a 3 word address, displayed according to the specified language.

Declared In

W3wIOSSDK.h

– autosuggest:language:focus:clip:

Returns a list of 3 word address suggestions, based on a full or partial 3 word address and other parameters. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word.

- (NSArray *)autosuggest:(NSString *)threeWordsAddress language:(NSString *)language focus:(W3wLatLng *)focus clip:(id<W3wClip>)clip

Parameters

threeWordsAddress

String containing exactly 3 words representing a full or partial 3 word address with a period separator

language

A supported 3 word address language as an ISO 639-1 2 letter code

focus

W3wLatLng coordinate hint to allow increased result relevancy

clip

W3wClip specifying the clip policy; allows for the resulting suggestions to be constrained to a geographic area

Return Value

Array of W3wSuggestion objects

Discussion

Returns a list of 3 word address suggestions, based on a full or partial 3 word address and other parameters. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word.

Declared In

W3wIOSSDK.h

– autosuggest:language:focus:clip:count:

Returns a list of 3 word address suggestions, based on a full or partial 3 word address and other parameters. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word.

- (NSArray *)autosuggest:(NSString *)threeWordsAddress language:(NSString *)language focus:(W3wLatLng *)focus clip:(id<W3wClip>)clip count:(int)count

Parameters

threeWordsAddress

String containing exactly 3 words representing a full or partial 3 word address with a period separator

language

A supported 3 word address language as an ISO 639-1 2 letter code

focus

W3wLatLng coordinate hint to allow increased result relevancy

clip

W3wClip specifying the clip policy; allows for the resulting suggestions to be constrained to a geographic area

count

Number of suggestions to return

Return Value

Array of W3wSuggestion objects

Discussion

Returns a list of 3 word address suggestions, based on a full or partial 3 word address and other parameters. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word.

Declared In

W3wIOSSDK.h

– voiceautosuggest:language:focus:clip:

Returns a list of 3 word address suggestions, based on the output from the Nuance VoCon Hybrid

- (NSArray *)voiceautosuggest:(NSString *)voconJSON language:(NSString *)language focus:(W3wLatLng *)focus clip:(id<W3wClip>)clip

Parameters

voconJSON

String containing JSON output from Nuance VoCon Hybrid

language

A supported 3 word address language as an ISO 639-1 2 letter code

focus

W3wLatLng coordinate hint to allow increased result relevancy

clip

W3wClip specifying the clip policy; allows for the resulting suggestions to be constrained to a geographic area

Return Value

Array of W3wSuggestion objects

Discussion

Returns a list of 3 word address suggestions, based on the output from the Nuance VoCon Hybrid

Declared In

W3wIOSSDK.h

– voiceautosuggest:language:focus:clip:count:

Returns a list of 3 word address suggestions, based on the output from the Nuance VoCon Hybrid

- (NSArray *)voiceautosuggest:(NSString *)voconJSON language:(NSString *)language focus:(W3wLatLng *)focus clip:(id<W3wClip>)clip count:(int)count

Parameters

voconJSON

String containing JSON output from Nuance VoCon Hybrid

language

A supported 3 word address language as an ISO 639-1 2 letter code

focus

W3wLatLng coordinate hint to allow increased result relevancy

clip

W3wClip specifying the clip policy; allows for the resulting suggestions to be constrained to a geographic area

count

Number of suggestions to return

Return Value

Array of W3wSuggestion objects

Discussion

Returns a list of 3 word address suggestions, based on the output from the Nuance VoCon Hybrid

Declared In

W3wIOSSDK.h

– standardBlend:lang:

Returns a blend of the most relevant 3 word address candidates based on a full or partial 3 word address. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word. The standardBlend method provides the search logic that powers the search box on map.what3words.com and in the what3words mobile apps.

- (NSArray *)standardBlend:(NSString *)threeWordAddress lang:(NSString *)lang

Parameters

threeWordAddress

String containing exactly 3 words representing a full or partial 3 word address with a period separator

lang

A supported 3 word address language as an ISO 639-1 2 letter code

Return Value

Array of W3wBlend objects

Discussion

Returns a blend of the most relevant 3 word address candidates based on a full or partial 3 word address. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word. The standardBlend method provides the search logic that powers the search box on map.what3words.com and in the what3words mobile apps.

Declared In

W3wIOSSDK.h

– standardBlend:focus:lang:

Returns a blend of the most relevant 3 word address candidates based on a full or partial 3 word address. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word. The standardBlend method provides the search logic that powers the search box on map.what3words.com and in the what3words mobile apps.

- (NSArray *)standardBlend:(NSString *)threeWordAddress focus:(W3wLatLng *)focus lang:(NSString *)lang

Parameters

threeWordAddress

String containing exactly 3 words representing a full or partial 3 word address with a period separator

focus

W3wLatLng coordinate containing the location that is to be used for relevance ranking

lang

A supported 3 word address language as an ISO 639-1 2 letter code

Return Value

Array of W3wBlend objects

Discussion

Returns a blend of the most relevant 3 word address candidates based on a full or partial 3 word address. The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word. The standardBlend method provides the search logic that powers the search box on map.what3words.com and in the what3words mobile apps.

Declared In

W3wIOSSDK.h

– romanise:

Romanise mongolian language

- (NSString *)romanise:(NSString *)cyrillicThreeWordAddress

Parameters

cyrillicThreeWordAddress

Cyrillic threeWordAddress string

Return Value

Romanised version of cyrillicThreeWordAddress

Discussion

Romanise mongolian language

Declared In

W3wIOSSDK.h

– loadedLanguages

Returns an array of the languages currently available to the what3words iOS SDK

- (NSArray *)loadedLanguages

Return Value

Array of language codes

Discussion

Returns an array of the languages currently available to the what3words iOS SDK

Declared In

W3wIOSSDK.h

– loadedLanguageCodes

Returns an array of the languages currently available to the what3words iOS SDK

- (NSArray *)loadedLanguageCodes

Return Value

Array of W3wLanguageCode objects

Discussion

Returns an array of the languages currently available to the what3words iOS SDK

Declared In

W3wIOSSDK.h

– distanceToPoint:point:

Calculate the distance, in metres, between the centroid of a three word address and a point

- (double)distanceToPoint:(NSString *)threeWordAddress point:(W3wLatLng *)point

Parameters

threeWordAddress

String containing exactly 3 words representing a valid 3 word address with a period separator

point

W3wLatLng containing the point’s coordinates

Return Value

A double containing the distance, in metres, between the centroid of the three word address and the point

Discussion

Calculate the distance, in metres, between the centroid of a three word address and a point

Declared In

W3wIOSSDK.h

– distanceBetweenPoints:endPoint:

Calculate the distance, in metres, between two points

- (double)distanceBetweenPoints:(W3wLatLng *)startPoint endPoint:(W3wLatLng *)endPoint

Parameters

startPoint

W3wLatLng containing the start point’s coordinates

endPoint

W3wLatLng containing the end point’s coordinates

Return Value

A double containing the distance, in metres, between the two points

Discussion

Calculate the distance, in metres, between two points

Declared In

W3wIOSSDK.h

– getVersion

Get the current version of the what3words iOS SDK that is in use

- (W3wVersionNumber *)getVersion

Return Value

what3words iOS SDK version number

Discussion

Get the current version of the what3words iOS SDK that is in use

Declared In

W3wIOSSDK.h

– getDataVersion

Get the current version of the what3words iOS SDK data files that are in use

- (W3wVersionNumber *)getDataVersion

Return Value

what3words iOS SDK data files version number

Discussion

Get the current version of the what3words iOS SDK data files that are in use

Declared In

W3wIOSSDK.h