HERE iOS SDK Developer's Guide

NMAPlaceTransitSchedulePage

Class Summary

class NMAPlaceTransitSchedulePage

Derived from: NSObject

Represents departure information for a public transport stop/station. Departure items are paginated based on NMARequest::collectionSize.

Include: NMAKit.framework/headers/NMAPlaceTransitSchedulePage.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAPlaceTransitSchedulePage

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSInteger  available

The total number of available NMATransitDeparture objects for this transit schedule page.

[readable, assign] NSArray< NMAPlaceTransitDeparture * > *  departures

Array of NMAPlaceTransitDeparture objects for the current page of results.

[readable, assign] NSDictionary< NSString *, NMAPlaceTransitLine * > *  lines

Dictionary of transit line names to NMAPlaceTransitLine objects for the current page of results.

[readable, assign] NMAPlaceTransitSchedulePageRequest nextPageRequest

The NMAPlaceTransitScheduleRequest for requesting the next page of results.

[readable, assign] NSInteger  offsetCount

Result offset of the current results page into the total number of results avilable.

[readable, assign] NSDictionary< NSString *, NMAPlaceTransitOperator * > *  operators

Dictionary of transit line operatiors to NMAPlaceTransitOperator objects for the current page of results.

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents departure information for a public transport stop/station. Departure items are paginated based on NMARequest::collectionSize.

NMAPlaceTransitScheduleRequest objects are typically created using the NMAPlaces interface to initialize search, explore or here requests.

Results may be split into multiple page. Each results page contains a collection of NMAPlaceTransitDeparture objects representing departure information.

Public Property Details

[readable, assign] NSInteger available

The total number of available NMATransitDeparture objects for this transit schedule page.

[readable, assign] NSArray< NMAPlaceTransitDeparture * > * departures

Array of NMAPlaceTransitDeparture objects for the current page of results.

[readable, assign] NSDictionary< NSString *, NMAPlaceTransitLine * > * lines

Dictionary of transit line names to NMAPlaceTransitLine objects for the current page of results.

Note:

The dictionary of transit lines serving departures shown in current departure item list using line name as key. Attempts to read this property could return nil.

[readable, assign] NMAPlaceTransitSchedulePageRequestnextPageRequest

The NMAPlaceTransitScheduleRequest for requesting the next page of results.

Note:

This will be nil if there is no next page.

[readable, assign] NSInteger offsetCount

Result offset of the current results page into the total number of results avilable.

Note:

The number of results on the current page is the number of elements in departures.

[readable, assign] NSDictionary< NSString *, NMAPlaceTransitOperator * > * operators

Dictionary of transit line operatiors to NMAPlaceTransitOperator objects for the current page of results.

Note:

The dictionary of operators operating on this stop/station using [ NMAPlaceTransitOperator uniqueId] as key. Attempts to read this property could return nil.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly