https://github.com/checkpointsw/smart-console-extensions
An extension can use JavaScript to interact with SmartConsole. The interactions provide access to information, such as the extension location context, and can perform certain basic operations. For example, navigate to a rule. Interactions can return data asynchronously by matching callbacks.
https://github.com/checkpointsw/smart-console-extensions
management-api
Last synced: 11 months ago
JSON representation
An extension can use JavaScript to interact with SmartConsole. The interactions provide access to information, such as the extension location context, and can perform certain basic operations. For example, navigate to a rule. Interactions can return data asynchronously by matching callbacks.
- Host: GitHub
- URL: https://github.com/checkpointsw/smart-console-extensions
- Owner: CheckPointSW
- Created: 2019-01-31T12:54:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T15:02:24.000Z (over 1 year ago)
- Last Synced: 2025-04-07T00:51:12.152Z (11 months ago)
- Topics: management-api
- Language: TypeScript
- Homepage:
- Size: 2.69 MB
- Stars: 22
- Watchers: 15
- Forks: 11
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# smart-console-interactions
> A JavaScript library to interact with SmartConsole Extension Platform
## Installation
```
$ npm install smart-console-interactions
```
## Basic Usage
```jsx
import SmartConsoleInteractions from 'smart-console-interactions';
.
.
const interactions = new SmartConsoleInteractions(demoInteraction);
const context = await this.interactions.getContextObject();
```
## API
**Functions**
- `query` - Execute query to get objects from the Security Management API.
- `getContextObject` -Extension context provided by SmartConsole.
- `requestCommit` - Request SmartConsole user to execute list of commands. Used by extensions to apply changes by SmartConsole user private session.
- `navigate` - Request SmartConsole to navigate to a rule.
- `closeExtensionWindow` - Request SmartConsole to close the extension window.
See [SmartConsole Extension Developer Guide](https://sc1.checkpoint.com/documents/SmartConsole/Extensions/index.html?ref=git) for additional information.