Skip to content

Commit 2b9fd2f

Browse files
committed
Update bookmark android shared models and methods
1 parent 576d0e3 commit 2b9fd2f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/bookmark/android/index.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -253,35 +253,32 @@ fun updateAddress(address: SharedData.AddressBookmark)
253253
:material-arrow-right: Update an existing favorite journey
254254

255255
```kotlin
256-
fun updateJourney(travelId: String, additionalInformation: String)
256+
fun updateJourney(journey: SharedData.JourneyBookmark)
257257
```
258258

259259
| Param | Type | Description |
260260
| --- | --- | --- |
261-
| `travelId` | `String` | Travel id of the favorite journey to update |
262-
| `additionalInformation` | `String` | Extra data to update |
261+
| `journey` | `SharedData.JourneyBookmark` | Favorite journey to update |
263262

264263
:material-arrow-right: Update an existing favorite POI
265264

266265
```kotlin
267-
fun updatePoi(id: String, additionalInformation: String)
266+
fun updatePoi(poi: SharedData.PoiBookmark)
268267
```
269268

270269
| Param | Type | Description |
271270
| --- | --- | --- |
272-
| `id` | `String` | Id of the favorite POI to update |
273-
| `additionalInformation` | `String` | Extra data to update |
271+
| `poi` | `SharedData.PoiBookmark` | Favorite poi to update |
274272

275273
:material-arrow-right: Update an existing favorite station
276274

277275
```kotlin
278-
fun updateStation(id: String, additionalInformation: String)
276+
fun updateStation(station: SharedData.StationBookmark)
279277
```
280278

281279
| Param | Type | Description |
282280
| --- | --- | --- |
283-
| `is` | `String` | Id of the favorite station to update |
284-
| `additionalInformation` | `String` | Extra data to update |
281+
| `station` | `SharedData.StationBookmark` | Favorite station to update |
285282

286283
<h4>Delete</h4>
287284

@@ -332,6 +329,7 @@ fun deleteStation(stopAreaId: String, lineId: String)
332329

333330
| Name | Required | Description | Type |
334331
| --- |:---:| --- | :---: |
332+
| `databaseId` | :material-check: | Unique database id | `Long?` |
335333
| `id` | :material-check: | Unique address id | `String` |
336334
| `name` | :material-check: | Address name | `String` |
337335
| `houseNumber` | :material-check: | House number | `Int` |
@@ -345,6 +343,7 @@ fun deleteStation(stopAreaId: String, lineId: String)
345343

346344
| Name | Required | Description | Type |
347345
| --- |:---:| --- | :---: |
346+
| `databaseId` | :material-check: | Unique database id | `Long?` |
348347
| `travelId` | :material-check: | Unique journey id | `String` |
349348
| `from` | :material-check: | Departure name | `String` |
350349
| `fromId` | :material-check: | Departure Navitia id | `String` |
@@ -386,6 +385,7 @@ fun deleteStation(stopAreaId: String, lineId: String)
386385

387386
| Name | Required | Description | Type |
388387
| --- |:---:| --- | :---: |
388+
| `databaseId` | :material-check: | Unique database id | `Long?` |
389389
| `id` | :material-check: | Unique POI id | `String` |
390390
| `coords` | :material-check: | POI coordinates | `LatLng` |
391391
| `name` | :material-check: | POI name | `String` |
@@ -399,6 +399,7 @@ fun deleteStation(stopAreaId: String, lineId: String)
399399

400400
| Name | Required | Description | Type |
401401
| --- |:---:| --- | :---: |
402+
| `databaseId` | :material-check: | Unique database id | `Long?` |
402403
| `stopAreaId` | :material-check: | Navitia stop area id | `String` |
403404
| `coords` | :material-check: | Station coordinates | `LatLng` |
404405
| `name` | :material-check: | Station name | `String` |

0 commit comments

Comments
 (0)