Engine  14.5.0
Factual's Engine SDK
Instance Methods | Properties | List of all members
PlaceCandidateResponse Class Reference

#import <EngineApiObjects.h>

Inheritance diagram for PlaceCandidateResponse:

Instance Methods

(nonnull instancetype) - initWithCandidates:location:
 
(nonnull instancetype) - initWithCandidates:location:timestamp:
 
(nonnull instancetype) - initFromDict:
 
(nonnull NSDictionary *) - toDict
 

Properties

NSDate * timestamp
 
CLLocation * location
 
NSArray< FactualPlace * > * candidates
 

Detailed Description

The response object from a call to FactualEngine's genPlaceCandidatesWithDelegate:.

Method Documentation

◆ initFromDict:()

- (nonnull instancetype) initFromDict: (nonnull NSDictionary *)  dictPlaceResponse

Constructs a PlaceCandidateResponse object from a NSDictionary representing a PlaceCandidateResponse.

Parameters
dictPlaceResponseA NSDictionary representing a PlaceCandidateResponse.
Returns
A PlaceCandidateResponse object

◆ initWithCandidates:location:()

- (nonnull instancetype) initWithCandidates: (nonnull NSArray< FactualPlace * > *)  candidates
location: (nonnull CLLocation *)  location 

Constructs a PlaceCandidateResponse object.

Parameters
candidatesThe candidates for the place attachment request ordered by confidence.
locationThe location of the place attachment request.
Returns
A PlaceCandidateResponse object

◆ initWithCandidates:location:timestamp:()

- (nonnull instancetype) initWithCandidates: (nonnull NSArray< FactualPlace * > *)  candidates
location: (nonnull CLLocation *)  location
timestamp: (nonnull NSDate *)  timestamp 

Constructs a PlaceCandidateResponse object.

Parameters
candidatesThe candidates for the place attachment request ordered by confidence.
locationThe location of the place attachment request.
timestampThe time of the place attachment request.
Returns
A PlaceCandidateResponse object

◆ toDict()

- (nonnull NSDictionary *) toDict

Returns the PlaceCandidateResponse as a NSDictionary.

Returns
The PlaceCandidateResponse as a NSDictionary.

Property Documentation

◆ candidates

- (NSArray<FactualPlace *>*) candidates
readatomicassign

The candidates for the place attachment request ordered by confidence.

◆ location

- (CLLocation*) location
readatomicassign

The location of the place attachment request.

◆ timestamp

- (NSDate*) timestamp
readatomicassign

The time of the place attachment request.


The documentation for this class was generated from the following file: