IGenericBookmark Interface
Assembly: Qlik.Engine.dll
This class describes all the methods that apply at bookmark level.
The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.
Syntax
public interface IGenericBookmark : IPropertyContainer, IQixClassBase, IDisposable, IChangeNotifierProperties
| Name | Description |
|---|---|
| Layout | |
| Properties |
Methods
| Name | Description |
|---|---|
| Apply() |
Applies a bookmark. |
| ApplyAndVerify() |
Applies a bookmark and verify result dataset against originally selected values. |
| ApplyAndVerifyAsync() |
Applies a bookmark and verify result dataset against originally selected values. |
| ApplyAndVerifyAsync(AsyncHandle) |
Applies a bookmark and verify result dataset against originally selected values. |
| ApplyAndVerifyAsync<T>(AsyncHandle, Func<Response, T>) |
Applies a bookmark and verify result dataset against originally selected values. |
| ApplyAsync() |
Applies a bookmark. |
| ApplyAsync(AsyncHandle) |
Applies a bookmark. |
| ApplyAsync<T>(AsyncHandle, Func<Response, T>) |
Applies a bookmark. |
| ApplyPatches(IEnumerable<NxPatch>) |
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future. |
| ApplyPatchesAsync(AsyncHandle, IEnumerable<NxPatch>) |
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future. |
| ApplyPatchesAsync(IEnumerable<NxPatch>) |
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future. |
| Approve() |
Adds the generic bookmark to the list of approved objects |
| ApproveAsync() |
Adds the generic bookmark to the list of approved objects |
| ApproveAsync(AsyncHandle) |
Adds the generic bookmark to the list of approved objects |
| GetFieldValues(String, Boolean, BookmarkFieldPage) |
Retrieves the values of a field. FieldvaluePlease refer to Engine API reference for table definition. |
| GetFieldValuesAsync(AsyncHandle, String, Boolean, BookmarkFieldPage) |
Retrieves the values of a field. FieldvaluePlease refer to Engine API reference for table definition. |
| GetFieldValuesAsync(String, Boolean, BookmarkFieldPage) |
Retrieves the values of a field. FieldvaluePlease refer to Engine API reference for table definition. |
| GetFieldValuesAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, BookmarkFieldPage) |
Retrieves the values of a field. FieldvaluePlease refer to Engine API reference for table definition. |
| GetInfo() |
Returns: * The type of the object. * The identifier of the object. |
| GetInfoAsync() |
Returns: * The type of the object. * The identifier of the object. |
| GetInfoAsync(AsyncHandle) |
Returns: * The type of the object. * The identifier of the object. |
| GetInfoAsync<T>(AsyncHandle, Func<Response, T>) |
Returns: * The type of the object. * The identifier of the object. |
| GetLayout() |
Evaluates an object and displays its properties including the dynamic properties. If the member |
| GetLayoutAsync() |
Evaluates an object and displays its properties including the dynamic properties. If the member |
| GetLayoutAsync(AsyncHandle) |
Evaluates an object and displays its properties including the dynamic properties. If the member |
| GetProperties() |
Shows the properties of an object. The following is always returned in the output: |
| GetPropertiesAsync() |
Shows the properties of an object. The following is always returned in the output: |
| GetPropertiesAsync(AsyncHandle) |
Shows the properties of an object. The following is always returned in the output: |
| Publish() |
Publishes a bookmark. |
| PublishAsync() |
Publishes a bookmark. |
| PublishAsync(AsyncHandle) |
Publishes a bookmark. |
| SetProperties(GenericBookmarkProperties) |
Sets some properties for a bookmark. |
| SetPropertiesAsync(AsyncHandle, GenericBookmarkProperties) |
Sets some properties for a bookmark. |
| SetPropertiesAsync(GenericBookmarkProperties) |
Sets some properties for a bookmark. |
| UnApprove() |
Removes the generic bookmark from the list of approved objects |
| UnApproveAsync() |
Removes the generic bookmark from the list of approved objects |
| UnApproveAsync(AsyncHandle) |
Removes the generic bookmark from the list of approved objects |
| UnPublish() |
Unpublishes a bookmark. |
| UnPublishAsync() |
Unpublishes a bookmark. |
| UnPublishAsync(AsyncHandle) |
Unpublishes a bookmark. |
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!