Class AddUserSession

Namespace

DuetAPI.Commands

Assembly

DuetAPI.dll

Register a new user session. Returns the ID of the new user session

[RequiredPermissions(SbcPermissions.ManageUserSessions)]
public class AddUserSession : Command<int>

Inheritance

object

BaseCommand

Command<int>

AddUserSession

Derived

AddUserSession

Inherited Members

Command<int>.ExecuteAsync(CancellationToken)

Command<int>.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AddUserSession()

public AddUserSession()

Properties

AccessLevel

Access level of this session

public AccessLevel AccessLevel { get; set; }

Property Value

AccessLevel

Origin

Origin of this session. For remote sessions, this equals the remote IP address

public string Origin { get; set; }

Property Value

string

SessionType

Type of this session

public SessionType SessionType { get; set; }

Property Value

SessionType

Methods

UpdateFromJson(JsonElement)

Update this instance from a given JSON element

public override void UpdateFromJson(JsonElement jsonElement)

Parameters

jsonElement JsonElement

Element to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader)

Update this instance from a given JSON element

public override void UpdateFromJsonReader(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Reader to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data