Interface IBookmarksManager

APIs for managing the report bookmarks.

export
interface: IBookmarksManager

Hierarchy

IBookmarksManager

Implemented by

BookmarksManager

Index

Methods

Methods

apply

apply(bookmarkName: string): Promise<IHttpPostMessageResponse<void>>

- Defined in src/bookmarksManager.ts:25
Parameters
- bookmarkName: string
Returns Promise<IHttpPostMessageResponse<void>>

applyState

applyState(state: string): Promise<IHttpPostMessageResponse<void>>

- Defined in src/bookmarksManager.ts:28
Parameters
- state: string
Returns Promise<IHttpPostMessageResponse<void>>

capture

capture(options?: ICaptureBookmarkOptions): Promise<IReportBookmark>

- Defined in src/bookmarksManager.ts:27
Parameters
- Optional options: ICaptureBookmarkOptions
Returns Promise<IReportBookmark>

getBookmarks

getBookmarks(): Promise<IReportBookmark[]>

- Defined in src/bookmarksManager.ts:24
Returns Promise<IReportBookmark[]>

play

play(playMode: BookmarksPlayMode): Promise<IHttpPostMessageResponse<void>>

- Defined in src/bookmarksManager.ts:26
Parameters
- playMode: BookmarksPlayMode
Returns Promise<IHttpPostMessageResponse<void>>

Generated using TypeDoc