sharee.bike-App/TINKLib/Repository/Response/BikeInfoBase.cs

84 lines
2.9 KiB
C#
Raw Normal View History

2022-04-25 22:15:15 +02:00
 using System.Runtime.Serialization;
2021-05-13 20:03:07 +02:00
2021-06-26 20:57:55 +02:00
namespace TINK.Repository.Response
2021-05-13 20:03:07 +02:00
{
/// <summary>
/// Holds info about a single bike.
/// </summary>
[DataContract]
public class BikeInfoBase
{
/// <summary>
/// Id of the bike.
/// </summary>
[DataMember]
2021-06-26 20:57:55 +02:00
public string bike { get; private set; }
2021-05-13 20:03:07 +02:00
/// <summary>
/// Id of the station.
/// </summary>
[DataMember]
2021-06-26 20:57:55 +02:00
public string station { get; private set; }
2021-05-13 20:03:07 +02:00
/// <summary>
/// Holds the localized (german) description of the bike.
/// </summary>
[DataMember]
public string description { get; private set; }
/// <summary> Holds the group of the bike.</summary>
/// <remarks>
/// Copri returns values "TINK", "Konrad".
/// </remarks>
[DataMember]
2021-06-26 20:57:55 +02:00
public string[] bike_group { get; private set; }
2021-05-13 20:03:07 +02:00
/// <summary>
/// Rental state.
/// </summary>
[DataMember]
public string state { get; private set; }
/// <summary>
/// Holds the uri where to reserve/ rent the bike.
/// </summary>
[DataMember]
public string uri_operator { get; private set; }
/// <summary> Holds whether bike is equipped with computer or if bike is a lock bike.</summary>
/// <remarks>
/// <table>
/// <tr><th>Value </th><th>Type of bike </th><th>Member to extract info.</th></tr>
/// <tr><td>LOCK </td><td>Bike with manual lock. </td><td>TextToTypeHelper.GetIsNonBikeComputerBike</td></tr>
2022-04-25 22:15:15 +02:00
/// <tr><td>BC </td><td>Bike with a bord computer. </td><td></td></tr>
/// <tr><td>Ilockit </td><td>Bike with a bluetooth lock.</td><td></td></tr>
/// <tr><td>sigo </td><td>Sigo bike.</td><td></td></tr>
2021-05-13 20:03:07 +02:00
/// </table>
/// </remarks>
[DataMember]
public string system { get; private set; }
#if !NOTARIFFDESCRIPTION
/// <summary> Holds the tariff information for a bike. </summary>
[DataMember]
public TariffDescription tariff_description { get; private set; }
#endif
2021-11-07 21:28:13 +01:00
/// <summary> Loading state of motor battery in % ]0..100[. </summary>
[DataMember]
public string bike_charge { get; private set; }
2022-04-25 22:15:15 +02:00
/// <summary> Locking state of the bike. </summary>
[DataMember]
public string lock_state { get; private set; }
2021-05-13 20:03:07 +02:00
/// <summary>
/// Textual description of response.
/// </summary>
/// <returns>Object as text.</returns>
public new string ToString()
{
return $"Bike {bike}{(station != null ? $", at station {station}" : string.Empty)}{(!string.IsNullOrEmpty(description) ? $", {description}" : string.Empty)}{(!string.IsNullOrEmpty(state) ? $", status={state}" : string.Empty)}.";
}
}
}