TNGetTripsRequest

@objcMembers
public class TNGetTripsRequest : TNDriveMotionRequest

Request class to get trips by time range. Create an instance through {@link TNGetTripsRequestBuilder#build()}. It supports paging query (not required) for trips within a certain time range.

  • The start date of the time range. Set the value through {@link TNGetTripsRequestBuilder#startDate(Date)}. If the start date is not set, you will get a TNDriveMotionException when creating the TNGetTripsRequest instance.

    Declaration

    Swift

    public let startDate: Date?

  • The end date of the time range. Set the value through {@link TNGetTripsRequestBuilder#endDate(Date)}. If the end date is not set or the end date is before the start date, you will get a TNDriveMotionException when creating the TNGetTripsRequest instance.

    Declaration

    Swift

    public let endDate: Date?
  • vin

    Vehicle vin

    Declaration

    Swift

    public let vin: String?

  • Maximum number of queries per page. Set the value through {@link TNGetTripsRequestBuilder#limit(int)}. Default value 20 and max limit is 100.

    Declaration

    Swift

    public let limit: Int

  • Please note that offset is a record index. Set the value through {@link TNGetTripsRequestBuilder#offset(int)} A query using offset and limit means that starting from “offset” and querying “limit” records, the result will include the records located in “offset”. Offset is the index of object that defines your place in the list, default is 0.

    Declaration

    Swift

    public let offset: Int

  • Trips sort order. Set the value through {@link TNGetTripsRequestBuilder#sortType(TripSortType)} Default value is TripSortType.tripStartTimeDESC

    Declaration

    Swift

    public let sortType: TripSortType

  • Trips transportation modes which request. Set the value through {@link TNGetTripsRequestBuilder#transportationModes(Array)} Default value is null for all type of trips.

    Declaration

    Swift

    public let transportationModes: Array<String>?

  • Indicates whether to exclude trip events info. Set the value through {@link TNGetTripsRequestBuilder#excludeTripEvents(Bool)} Default is true. if not, include.

    Declaration

    Swift

    public let excludeTripEvents: Bool

  • Trip selection status. Set the value throught {@link TNGetTripsRequestBuilder#tripSelectionStatus(TripSelectionStatus)}

    Declaration

    Swift

    public let tripSelectionStatus: AllTripSelectionStatus

  • Build a {@link TNGetTripsRequestBuilder} instance used for setting request condition @return {@link TNGetTripsRequestBuilder} instance

    Declaration

    Swift

    public static func builder() -> TNGetTripsRequestBuilder

  • Undocumented

    Declaration

    Swift

    public override func encode(to encoder: Encoder) throws