TextStudioActionDefinition

ClassTextStudioTextStudio

public sealed class TextStudioActionDefinition

Immutable discovery metadata and parameter schema for a registered action tag.

Constructors

TextStudioActionDefinition(string, string, string, bool, string[], string[], TextStudioTagParameterDefinition[])

public TextStudioActionDefinition(string id, string displayName = null, string description = null, bool isMarker = false, string[] aliases = null, string[] examples = null, TextStudioTagParameterDefinition[] parameters = null)

Creates an action definition with aliases, examples, and parameter metadata.

Parameters

Name	Type
id	System.String
displayName	System.String
description	System.String
isMarker	System.Boolean
aliases	System.String[]
examples	System.String[]
parameters	TextStudio.TextStudioTagParameterDefinition[]

Properties

Id

public string Id { get; }

Returns

System.String

DisplayName

public string DisplayName { get; }

Returns

System.String

Description

public string Description { get; }

Returns

System.String

IsMarker

public bool IsMarker { get; }

Returns

System.Boolean

Aliases

public IReadOnlyList<string> Aliases { get; }

Returns

System.Collections.Generic.IReadOnlyList{System.String}

Examples

public IReadOnlyList<string> Examples { get; }

Returns

System.Collections.Generic.IReadOnlyList{System.String}

Parameters

public IReadOnlyList<TextStudioTagParameterDefinition> Parameters { get; }

Returns

System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioTagParameterDefinition}