Skip to content

hotfix/bookmark ios doc #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 2, 2024
Merged

hotfix/bookmark ios doc #173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5086d93
Merge pull request #171 from hove-io/hotfix/19-11-24
EvenModiguy Nov 19, 2024
0138df2
Add update methods
Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 35 additions & 9 deletions docs/bookmark/ios/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The various CRD methods are accessed through `BookmarkUI.shared`.

<h4>Create</h4>

:material-arrow-right: Create a new favorite address. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Create a new favorite address. Returns a boolean if the creation has succeeded or not.

``` swift
func addFavoriteAddress(_ address: SharedData.FavoriteAddress) -> Bool
Expand All @@ -173,7 +173,7 @@ func addFavoriteAddress(_ address: SharedData.FavoriteAddress) -> Bool
| --- | --- | --- |
| `address` | [`SharedData.FavoriteAddress`](#favorite-address) | Favorite address to create |

:material-arrow-right: Create a new favorite journey. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Create a new favorite journey. Returns a boolean if the creation has succeeded or not.

``` swift
func addFavoriteJourney(_ journey: SharedData.FavoriteJourney) -> Bool
Expand All @@ -183,7 +183,7 @@ func addFavoriteJourney(_ journey: SharedData.FavoriteJourney) -> Bool
| --- | --- | --- |
| `journey` | [`SharedData.FavoriteJourney`](#favorite-journey) | Favorite journey to create |

:material-arrow-right: Create a new favorite POI. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Create a new favorite POI. Returns a boolean if the creation has succeeded or not.

``` swift
func addFavoritePoi(_ poi: SharedData.FavoritePoi) -> Bool
Expand All @@ -193,7 +193,7 @@ func addFavoritePoi(_ poi: SharedData.FavoritePoi) -> Bool
| --- | --- | --- |
| `poi` | [`SharedData.FavoritePoi`](#favorite-poi)| Favorite POI to create |

:material-arrow-right: Create a new favorite station. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Create a new favorite station. Returns a boolean if the creation has succeeded or not.

``` swift
func addFavoriteStation(_ station: SharedData.FavoriteStation) -> Bool
Expand Down Expand Up @@ -235,7 +235,7 @@ func fetchFavoriteJourneys(max: Int) -> [SharedData.FavoriteJourney]
| --- | --- | --- |
| `max` | `Int` | Limit the result count. `0` for all data |

:material-arrow-right: Get if a journey is added to favorites. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Get if a journey is added to favorites. Returns a boolean if the creation has succeeded or not.

``` swift
func isJourneyInBookmark(journeyId: String) -> Bool
Expand Down Expand Up @@ -286,9 +286,35 @@ func fetchFavoriteStations(max: Int) -> [SharedData.FavoriteStation]
| --- | --- | --- |
| `max` | `Int` | Limit the result count. `0` for all data |

<h4>Update</h4>

:material-arrow-right:v Update an existing favorite address. Returns a boolean if the update has succeeded or not.

``` swift
func updateFavoriteAddress(updatedAddress: SharedData.FavoriteAddress) -> Bool
```

:material-arrow-right:v Update an existing favorite POI. Returns a boolean if the creation has succeeded or not.

``` swift
func updateFavoritePoi(updatedPoi: SharedData.FavoritePoi) -> Bool
```

:material-arrow-right:v Update an existing favorite station. Returns a boolean if the update has succeeded or not.

``` swift
func updateFavoriteStation(updatedStation: SharedData.FavoriteStation) -> Bool
```

:material-arrow-right:v Update an existing favorite journey. Returns a boolean if the update has succeeded or not.

``` swift
func updateFavoriteJourney(updatedJourney: SharedData.FavoriteJourney) -> Bool
```

<h4>Delete</h4>

:material-arrow-right:v Delete an existing favorite address. Returns a boolean if the creation has succeed or not.
:material-arrow-right:v Delete an existing favorite address. Returns a boolean if the creation has succeeded or not.

``` swift
func deleteFavoriteAddress(id: String) -> Bool
Expand All @@ -298,7 +324,7 @@ func deleteFavoriteAddress(id: String) -> Bool
| --- | --- | --- |
| `id` | `String` | Id of the favorite address to delete |

:material-arrow-right: Delete an existing favorite journey. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Delete an existing favorite journey. Returns a boolean if the creation has succeeded or not.

``` swift
func deleteFavoriteJourney(id: String) -> Bool
Expand All @@ -308,7 +334,7 @@ func deleteFavoriteJourney(id: String) -> Bool
| --- | --- | --- |
| `id` | `String` | Id of the favorite journey to delete |

:material-arrow-right: Delete an existing favorite POI. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Delete an existing favorite POI. Returns a boolean if the creation has succeeded or not.

``` swift
func deleteFavoritePoi(id: String) -> Bool
Expand All @@ -318,7 +344,7 @@ func deleteFavoritePoi(id: String) -> Bool
| --- | --- | --- |
| `id` | `String` | Id of the favorite POI to delete |

:material-arrow-right: Delete an existing favorite station. Returns a boolean if the creation has succeed or not.
:material-arrow-right: Delete an existing favorite station. Returns a boolean if the creation has succeeded or not.

``` swift
func deleteFavoriteStation(id: String) -> Bool
Expand Down