Interface SoftwareComponent

Provide information about your integration and other client software components for the about dialog and analytics.

interface SoftwareComponent {
    category?: string;
    id: string;
    name: string;
    version: string;
}

category?: string

Check SoftwareComponentCategory to choose the right value for your component. By default value this value will be set to 'DEFAULT'.

id: string

The id of the software component. Examples: 'com.acrolinx.win.word.32bit', 'com.acrolinx.mac.word'

name: string

The name if the software component. This name will be displayed in the sidebars about dialog.

version: string

The version of the software component. @format: ${major}.${minor}.${patch}.${buildNumber} @example: '1.2.3.574'

Properties