ReplaceBookmarkAsync Method
Overloads
| ReplaceBookmarkAsync(String, Boolean, IEnumerable<String>) |
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out. |
|
| ReplaceBookmarkAsync(AsyncHandle, String, Boolean, IEnumerable<String>) |
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out. |
|
| ReplaceBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, IEnumerable<String>) |
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out. |
ReplaceBookmarkAsync(String, Boolean, IEnumerable<String>)
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.
Declaration
Task<ReplaceBookmarkResult> ReplaceBookmarkAsync([QixName("qId")] string id, [QixName("qIgnorePatches")] bool ignorePatches = false, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Identifier of the bookmark. |
| System.Boolean | ignorePatches |
Set to true to exclude patches from the bookmark. Default is false. |
| System.Collections.Generic.IEnumerable<System.String> | objectIdsToPatch |
Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ReplaceBookmarkResult> |
ReplaceBookmarkAsync(AsyncHandle, String, Boolean, IEnumerable<String>)
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.
Declaration
Task<ReplaceBookmarkResult> ReplaceBookmarkAsync(AsyncHandle asyncHandle, [QixName("qId")] string id, [QixName("qIgnorePatches")] bool ignorePatches = false, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | id |
Identifier of the bookmark. |
| System.Boolean | ignorePatches |
Set to true to exclude patches from the bookmark. Default is false. |
| System.Collections.Generic.IEnumerable<System.String> | objectIdsToPatch |
Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ReplaceBookmarkResult> |
ReplaceBookmarkAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, IEnumerable<String>)
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.
Declaration
Task<T> ReplaceBookmarkAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id, [QixName("qIgnorePatches")] bool ignorePatches = false, [QixName("qObjectIdsToPatch")] IEnumerable<string> objectIdsToPatch = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | id |
Identifier of the bookmark. |
| System.Boolean | ignorePatches |
Set to true to exclude patches from the bookmark. Default is false. |
| System.Collections.Generic.IEnumerable<System.String> | objectIdsToPatch |
Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!