Skip to content

plugin.md

Latest commit

 

History

History
71 lines (51 loc) · 1.43 KB

plugin.md

File metadata and controls

71 lines (51 loc) · 1.43 KB
Raw

Plugin Documentation

Overview

This is a sample plugin demonstrating an API call action. It fetches data from a time API endpoint.

Dependencies

Backend

dependencies {
    implementation("com.ritense.valtimoplugins:sample-plugin:0.0.1")
}

Frontend

{
  "dependencies": {
    "@valtimo-plugins/sample-plugin": "0.0.1"
  }
}

In your app.module.ts:

import {
    SamplePluginModule, samplePluginSpecification,
} from '@valtimo-plugins/sample-plugin';

@NgModule({
    imports: [
        SamplePluginModule,
    ],
    providers: [
        {
            provide: PLUGIN_TOKEN,
            useValue: [
                samplePluginSpecification,
            ]
        }
    ]
})

Configuration

List the plugin configuration properties and how to set them.

Property Type Required Description
apiUrl string Yes The URL of the time API to call

Actions

Time API test action

Sends a GET request to the configured API URL and returns the timezone response.

Parameter Type Required Description

Usage

Explain how to use the plugin in a process, with examples if applicable.