SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias PluginApiDescriptor

    PluginApiDescriptor: Message<"soulfire.v1.PluginApiDescriptor"> & {
        apiMajorVersion: number;
        author: string;
        description: string;
        descriptorSha256: string;
        documentationUrl?: string;
        eventTypes: PluginEventTypeDescriptor[];
        eventTypeUrls: string[];
        license: string;
        permissions: PluginPermissionDescriptor[];
        pluginId: string;
        pluginVersion: string;
        requiredSoulfireVersion: string;
        sdkPackages?: PluginSdkPackages;
        services: PluginRpcServiceDescriptor[];
        sourceUrl?: string;
        stability: PluginApiStability;
        taskTypes: PluginTaskTypeDescriptor[];
        taskTypeUrls: string[];
        websiteUrl: string;
    }

    Complete discoverable description of a plugin API.

    Type Declaration

    • apiMajorVersion: number

      from field: uint32 api_major_version = 8;

    • author: string

      from field: string author = 4;

    • description: string

      from field: string description = 3;

    • descriptorSha256: string

      from field: string descriptor_sha256 = 9;

    • OptionaldocumentationUrl?: string

      from field: optional string documentation_url = 16;

    • eventTypes: PluginEventTypeDescriptor[]

      from field: repeated soulfire.v1.PluginEventTypeDescriptor event_types = 18;

    • eventTypeUrls: string[]

      from field: repeated string event_type_urls = 12;

    • license: string

      from field: string license = 5;

    • permissions: PluginPermissionDescriptor[]

      from field: repeated soulfire.v1.PluginPermissionDescriptor permissions = 11;

    • pluginId: string

      from field: string plugin_id = 1;

    • pluginVersion: string

      from field: string plugin_version = 2;

    • requiredSoulfireVersion: string

      from field: string required_soulfire_version = 7;

    • OptionalsdkPackages?: PluginSdkPackages

      from field: soulfire.v1.PluginSdkPackages sdk_packages = 15;

    • services: PluginRpcServiceDescriptor[]

      from field: repeated soulfire.v1.PluginRpcServiceDescriptor services = 10;

    • OptionalsourceUrl?: string

      from field: optional string source_url = 17;

    • stability: PluginApiStability

      from field: soulfire.v1.PluginApiStability stability = 14;

    • taskTypes: PluginTaskTypeDescriptor[]

      from field: repeated soulfire.v1.PluginTaskTypeDescriptor task_types = 19;

    • taskTypeUrls: string[]

      from field: repeated string task_type_urls = 13;

    • websiteUrl: string

      from field: string website_url = 6;

    from message soulfire.v1.PluginApiDescriptor

    Settings
    Member Visibility