TKVehicular

Objective-C

@protocol TKVehicular <NSObject>

/**
 Optional name to use in the UI to refer to this vehicle.
 */
- (nullable NSString *)name;

/**
 What kind of vehicle it is. Required field.
 */
- (TKVehicleType)vehicleType;

@optional

/**
 Where this vehicle is garaged. Can be `nil` but the algorithms won't try to
 take it back to the garage then.
 
 @note `nil` is the same as getting a lift
 */
- (nullable id<MKAnnotation>)garage;

/**
 The unique identifier that identifies this vehicle.
 
 @note Getting a lift instances don't have a UUID
 */
- (nullable NSString *)vehicleUUID;

@end

Swift

protocol TKVehicular : NSObjectProtocol

Undocumented

  • Optional name to use in the UI to refer to this vehicle.

    Declaration

    Objective-C

    - (nullable NSString *)name;

    Swift

    func name() -> String?
  • What kind of vehicle it is. Required field.

    Declaration

    Objective-C

    - (TKVehicleType)vehicleType;

    Swift

    func vehicleType() -> TKVehicleType
  • Where this vehicle is garaged. Can be nil but the algorithms won’t try to take it back to the garage then.

    Note

    nil is the same as getting a lift

    Declaration

    Objective-C

    - (nullable id<MKAnnotation>)garage;

    Swift

    optional func garage() -> MKAnnotation?
  • The unique identifier that identifies this vehicle.

    Note

    Getting a lift instances don’t have a UUID

    Declaration

    Objective-C

    - (nullable NSString *)vehicleUUID;

    Swift

    optional func vehicleUUID() -> String?