DPB1Class · 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 Message
Reference: DPB1 0.3.29.56Compare the DPB2 reference → Check signatures and usage notes separately; a matching type is not a compatibility guarantee.

Members and overloads

18 declared here

Message

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

Creates a new Message instance using the supplied arguments.

Parameters

id
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies id.

sender
Parameter type: objectNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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.

Parameters

id
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies id.

sender
Parameter type: objectNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies sender.

input
Parameter type: dynamic[]No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies input.

AddInput

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

Adds input using the supplied arguments.

Return type: voidNo return value.

Parameters

input
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies input.

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

AddInputs

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

Adds inputs using the supplied arguments.

Return type: voidNo return value.

Parameters

input
Parameter type: dynamic[]No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies input.

AddOutput

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

Adds output using the supplied arguments.

Return type: voidNo return value.

Parameters

handler
Parameter type: IMessageHandler

Specifies handler.

output
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies output.

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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.

Return type: voidNo return value.

Parameters

handler
Parameter type: IMessageHandler

Specifies handler.

output
Parameter type: dynamic[]No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies output.

GetInput

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

Calls GetInput on Message with index and returns T. Open the return contract below before using the result.

Return type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

index
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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

Returns: The T result.

GetInput

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

Calls GetInput on Message with name and returns T. Open the return contract below before using the result.

Return type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

Returns: The T result.

GetOutput

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

Calls GetOutput on Message with index and returns T. Open the return contract below before using the result.

Return type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

index
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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

Returns: The T result.

GetOutput

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

Calls GetOutput on Message with name and returns T. Open the return contract below before using the result.

Return type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

Returns: The T result.

TryGetInput

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

Calls TryGetInput on Message with index, input and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

index
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies index.

input
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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)

Calls TryGetInput on Message with name, input and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

input
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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)

Calls TryGetOutput on Message with index, input and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

index
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies index.

input
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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)

Calls TryGetOutput on Message with name, output and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

output
Parameter type: TNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives output.

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

Id

PropertyLink ↗
public string Message.Id { get; }

Reads id on Message as string. The exact type and accessors are shown below.

Value type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Inputs

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

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

Value type: IReadOnlyList<Tuple<object, string>>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Outputs

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

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

Value type: IReadOnlyList<Tuple<IMessageHandler, object, string>>
Explore IMessageHandler → members & methods

Defines the message handler contract. Implement the listed members to provide this capability.

Sender

PropertyLink ↗
public object Message.Sender { get; }

Reads sender on Message as object. The exact type and accessors are shown below.

Value type: objectNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Guides using this class

See how these APIs fit together. Labs include complete source; the FollowBot walkthrough teaches you to build your own bot from selected fragments and checkpoints.

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