Class SubscribeInitMessage

Enter subscription mode and receive either the full object model or parts of it after every update

Inheritance
object
ClientInitMessage
SubscribeInitMessage
Inherited Members
Namespace: DuetAPI.Connection.InitMessages
Assembly: DuetAPI.dll
Syntax
public class SubscribeInitMessage : ClientInitMessage

Constructors

SubscribeInitMessage()

Creates a new init message instance

Declaration
public SubscribeInitMessage()

Properties

Channel

Optional code channel to receive messages from or null if only generic messages are supposed to be received

Declaration
public CodeChannel? Channel { get; set; }
Property Value
Type Description
CodeChannel?

Filter

Optional filter path for Patch mode

Declaration
[Obsolete("Use Filters instead")]
public string? Filter { get; set; }
Property Value
Type Description
string
Remarks

Multiple filters can be used on one connection and they have to be delimited by one of these charaters: ['|', ',', ' ', '\r', '\n']

See Also

Filters

Optional list of filter paths for Patch mode

Declaration
public List<string> Filters { get; set; }
Property Value
Type Description
List<string>
Remarks

The style of a filter is similar to XPath. For example, if you want to monitor only the current heater temperatures, you can use the filter expression "heat/heaters[*]/current". Wildcards are supported either for full names or indices. To get updates for an entire namespace, the ** wildcard can be used (for example heat/** for everything heat-related), however it can be only used at the end of a filter expression

SubscriptionMode

Type of the subscription

Declaration
public SubscriptionMode SubscriptionMode { get; set; }
Property Value
Type Description
SubscriptionMode