ActionsTrait.EndpointListStruct

class ActionsTrait.EndpointListStruct


The details of a single endpoint list, a set of endpoints that have some logical relation.

Summary

Public constructors

EndpointListStruct(
    endpointListId: UShort,
    name: String,
    type: ActionsTrait.EndpointListTypeEnum,
    endpoints: List<UShort>
)

Creates the EndpointListStruct class.

Public properties

UShort
List<UShort>

A list of endpoint numbers.

String

The name, as assigned by the user or automatically by the server, associated with the set of endpoints in this list.

ActionsTrait.EndpointListTypeEnum

The type of endpoint list.

Public constructors

EndpointListStruct

EndpointListStruct(
    endpointListId: UShort,
    name: String = "",
    type: ActionsTrait.EndpointListTypeEnum = EndpointListTypeEnum.Other,
    endpoints: List<UShort> = emptyList()
)

Creates the EndpointListStruct class.

Public properties

endpointListId

val endpointListIdUShort

endpoints

val endpointsList<UShort>

A list of endpoint numbers.

name

val nameString

The name, as assigned by the user or automatically by the server, associated with the set of endpoints in this list. This can be used for identifying the action to the user by the client. For example, "living room".

type

val typeActionsTrait.EndpointListTypeEnum

The type of endpoint list.