Table of Contents

Class HttpEndpoint

Namespace
DuetAPI.ObjectModel
Assembly
DuetAPI.dll

Class representing an extra HTTP endpoint

public class HttpEndpoint : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged
Inheritance
HttpEndpoint
Implements
Inherited Members

Constructors

HttpEndpoint() 

public HttpEndpoint()

Fields

RepRapFirmwareNamespace

Namespace prefix used for RepRapFirmware HTTP requests

public const string RepRapFirmwareNamespace = "rr_"

Field Value

string

Properties

EndpointType

HTTP type of this endpoint

public HttpEndpointType EndpointType { get; set; }

Property Value

HttpEndpointType

IsUploadRequest

Whether this is a upload request

public bool IsUploadRequest { get; set; }

Property Value

bool

Remarks

If set to true, the whole body payload is written to a temporary file and the file path is passed via the Body property

Namespace

Namespace of the endpoint

public string Namespace { get; set; }

Property Value

string

Remarks

May be RepRapFirmwareNamespace to register root-level rr_ requests (to emulate RRF poll requests)

Path

Path to the endpoint

public string Path { get; set; }

Property Value

string

UnixSocket

Path to the UNIX socket

public string UnixSocket { get; set; }

Property Value

string

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

See Also

AddHttpEndpoint
RemoveHttpEndpoint