DPB2Class · Bots, plugins and tasks

Message

Carry a named request and its arguments between components. Read inputs and outputs using the agreed message contract.

Namespace: DreamPoeBot.Loki.Bot

public class MessageView DPB1 version →

Members and overloads

18 results

Message

MethodLink ↗
public Message.Message(string id, object sender = null)

Creates a new Message instance using the supplied arguments.

idstring
Specifies id.
senderobject
Specifies sender. Optional; the default is shown in the signature.

Message

MethodLink ↗
public Message.Message(string id, object sender, params dynamic[] input)

Creates a new Message instance using the supplied arguments.

idstring
Specifies id.
senderobject
Specifies sender.
inputdynamic[]
Specifies input.

AddInput

MethodLink ↗
public void Message.AddInput<T>(T input, string name)

Adds input using the supplied arguments.

inputT
Specifies input.
namestring
Specifies name.

AddInputs

MethodLink ↗
public void Message.AddInputs(params dynamic[] input)

Adds inputs using the supplied arguments.

inputdynamic[]
Specifies input.

AddOutput

MethodLink ↗
public void Message.AddOutput<T>(IMessageHandler handler, T output, string name = "")

Adds output using the supplied arguments.

handlerIMessageHandler
Specifies handler.
outputT
Specifies output.
namestring
Specifies name. Optional; the default is shown in the signature.

AddOutputs

MethodLink ↗
public void Message.AddOutputs(IMessageHandler handler, params dynamic[] output)

Adds outputs using the supplied arguments.

handlerIMessageHandler
Specifies handler.
outputdynamic[]
Specifies output.

GetInput

MethodLink ↗
public T Message.GetInput<T>(int index = 0)

Returns input using the supplied arguments.

indexint
Specifies index. Optional; the default is shown in the signature.

Returns: The T result.

GetInput

MethodLink ↗
public T Message.GetInput<T>(string name)

Returns input using the supplied arguments.

namestring
Specifies name.

Returns: The T result.

GetOutput

MethodLink ↗
public T Message.GetOutput<T>(int index = 0)

Returns output using the supplied arguments.

indexint
Specifies index. Optional; the default is shown in the signature.

Returns: The T result.

GetOutput

MethodLink ↗
public T Message.GetOutput<T>(string name)

Returns output using the supplied arguments.

namestring
Specifies name.

Returns: The T result.

TryGetInput

MethodLink ↗
public bool Message.TryGetInput<T>(int index, out T input)

Attempts to retrieve input using the supplied arguments.

indexint
Specifies index.
inputT
Receives input.

Returns: True when the request succeeds; read any out parameters only after checking the result.

TryGetInput

MethodLink ↗
public bool Message.TryGetInput<T>(string name, out T input)

Attempts to retrieve input using the supplied arguments.

namestring
Specifies name.
inputT
Receives input.

Returns: True when the request succeeds; read any out parameters only after checking the result.

TryGetOutput

MethodLink ↗
public bool Message.TryGetOutput<T>(int index, out T input)

Attempts to retrieve output using the supplied arguments.

indexint
Specifies index.
inputT
Receives input.

Returns: True when the request succeeds; read any out parameters only after checking the result.

TryGetOutput

MethodLink ↗
public bool Message.TryGetOutput<T>(string name, out T output)

Attempts to retrieve output using the supplied arguments.

namestring
Specifies name.
outputT
Receives output.

Returns: True when the request succeeds; read any out parameters only after checking the result.

Id

PropertyLink ↗
public string Message.Id { get; }

Gets id for Message.

Inputs

PropertyLink ↗
public IReadOnlyList<Tuple<object, string>> Message.Inputs { get; }

Gets the inputs collection. Its element types are linked below.

Outputs

PropertyLink ↗
public IReadOnlyList<Tuple<IMessageHandler, object, string>> Message.Outputs { get; }

Gets the outputs collection. Its element types are linked below.

Sender

PropertyLink ↗
public object Message.Sender { get; }

Gets sender for Message.

DPB2 0.4.5.88 · Reference reviewed 2026-10-02. Descriptions use source summaries where available, otherwise concise signature-based descriptions. Examples illustrate usage; they are not a live-game test.