Class RequestNavigationTargetsAction

Namespace

NMF.Glsp.Protocol.Navigation

Assembly

NMF.Glsp.dll

Action that is usually sent from the client to the server to request navigation targets for a specific navigation type such as documentation or implementation in the given editor context.

public class RequestNavigationTargetsAction : RequestAction

Inheritance

object

BaseAction

ExecutableAction

RequestAction

RequestNavigationTargetsAction

Inherited Members

RequestAction.RequestId

ExecutableAction.RequireTransaction()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

RequestNavigationTargetsActionKind

The kind value used for this kind of action

public const string RequestNavigationTargetsActionKind = "requestNavigationTargets"

Field Value

string

Properties

EditorContext

The current editor context.

public EditorContext EditorContext { get; init; }

Property Value

EditorContext

Kind

Unique identifier specifying the kind of action to process.

public override string Kind { get; }

Property Value

string

TargetTypeId

Identifier of the type of navigation targets we want to retrieve, e.g., 'documentation', 'implementation', etc.

public string TargetTypeId { get; init; }

Property Value

string

Methods

ExecuteAsync(IGlspSession)

Executes the action in the context of the given session

public override Task ExecuteAsync(IGlspSession session)

Parameters

session IGlspSession

The session in which to execute the action

Returns

Task