public class BookmarksApi extends Object
| Constructor and Description |
|---|
BookmarksApi() |
BookmarksApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
BookmarkResponse |
createBookmark(Bookmark body)
createBookmark
Saves a bookmark in the database
|
void |
deleteBookmark(UUID id)
deleteBookmark
Deletes a bookmark identified by the given ID
|
BookmarkResponse |
deleteWorkingCopy(UUID id)
deleteWorkingCopy
Deletes a working copy for a bookmark stored in the database
|
ApiClient |
getApiClient() |
BookmarkResponse |
getBookmark(UUID id,
Boolean markAsViewed)
getBookmark
Retrieves a bookmark by ID
|
BookmarkListResponse |
getBookmarks(String bookmarkType,
String groupKey)
getBookmarks
Retrieves all stored bookmarks a user can read.
|
void |
setApiClient(ApiClient apiClient) |
BookmarkResponse |
updateBookmark(UUID id,
Bookmark body)
updateBookmark
Updates a bookmark stored in the database
|
BookmarkResponse |
updateWorkingCopy(UUID id,
BookmarkWorkingCopy body)
updateWorkingCopy
Updates a working copy for a bookmark stored in the database
|
public BookmarksApi()
public BookmarksApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public BookmarkResponse createBookmark(Bookmark body) throws ApiException
body - bookmark (optional)ApiException - if fails to make API callpublic void deleteBookmark(UUID id) throws ApiException
id - (required)ApiException - if fails to make API callpublic BookmarkResponse deleteWorkingCopy(UUID id) throws ApiException
id - (required)ApiException - if fails to make API callpublic BookmarkResponse getBookmark(UUID id, Boolean markAsViewed) throws ApiException
id - (required)markAsViewed - (optional, default to true)ApiException - if fails to make API callpublic BookmarkListResponse getBookmarks(String bookmarkType, String groupKey) throws ApiException
bookmarkType - Specifies the bookmark type (required)groupKey - A key used to separate bookmarks within the same query type (optional)ApiException - if fails to make API callpublic BookmarkResponse updateBookmark(UUID id, Bookmark body) throws ApiException
id - (required)body - bookmark (optional)ApiException - if fails to make API callpublic BookmarkResponse updateWorkingCopy(UUID id, BookmarkWorkingCopy body) throws ApiException
id - (required)body - workingCopy (optional)ApiException - if fails to make API callCopyright © 2019 LeanIX GmbH. All rights reserved.