Skip to main content

Class: GetUserSettingsCommand

Defined in: src/common/web/api/user/UserCommands.ts:64

Command to get the settings of the current user. Requires a GetUserSettingsReply reply.

Extends​

Constructors​

Constructor​

new GetUserSettingsCommand(name, origin, sender, target, hops, trace, apiKey): GetUserSettingsCommand

Defined in: src/common/web/core/messaging/Message.ts:63

Parameters​

name​

string

The name of the message.

origin​

UnitID

The initial source component of the message.

sender​

UnitID

The component from where the message came from.

target​

Channel

Where the message should go to.

hops​

UnitID[] = []

A list of components the message was sent through.

trace​

string = ...

A unique trace identifying messages that logically belong together.

apiKey​

string = ""

An optional API key to access protected resources.

Returns​

GetUserSettingsCommand

Inherited from​

Command.constructor

Properties​

api_key​

readonly api_key: string = ""

Defined in: src/common/web/core/messaging/Message.ts:50

Inherited from​

Command.api_key

hops​

readonly hops: UnitID[] = []

Defined in: src/common/web/core/messaging/Message.ts:46

Inherited from​

Command.hops

name​

readonly name: string

Defined in: src/common/web/core/messaging/Message.ts:33

Inherited from​

Command.name

origin​

readonly origin: UnitID

Defined in: src/common/web/core/messaging/Message.ts:36

Inherited from​

Command.origin

payload​

readonly payload: MessagePayload

Defined in: src/common/web/core/messaging/Message.ts:52

Inherited from​

Command.payload

sender​

readonly sender: UnitID

Defined in: src/common/web/core/messaging/Message.ts:39

Inherited from​

Command.sender

target​

readonly target: Channel

Defined in: src/common/web/core/messaging/Message.ts:42

Inherited from​

Command.target

trace​

readonly trace: string = ""

Defined in: src/common/web/core/messaging/Message.ts:48

Inherited from​

Command.trace

unique​

readonly unique: string

Defined in: src/common/web/core/messaging/Command.ts:17

Inherited from​

Command.unique

Category​

readonly static Category: string = "Command"

Defined in: src/common/web/core/messaging/Command.ts:15

Inherited from​

Command.Category

Accessors​

messageCategory​

Get Signature​

get messageCategory(): string

Defined in: src/common/web/core/messaging/Command.ts:22

Gets the global message category.

Returns​

string

Inherited from​

Command.messageCategory

Methods​

convertToJSON()​

convertToJSON(): string

Defined in: src/common/web/core/messaging/Message.ts:76

Converts this message to JSON.

Returns​

string

Inherited from​

Command.convertToJSON

toString()​

toString(): string

Defined in: src/common/web/core/messaging/Message.ts:154

Gets the string representation of this message.

Returns​

string

Inherited from​

Command.toString

build()​

static build(messageBuilder, chain): CommandComposer<GetUserSettingsCommand>

Defined in: src/common/web/api/user/UserCommands.ts:68

Helper function to easily build this message.

Parameters​

messageBuilder​

MessageBuilder

chain​

null | Message

Returns​

CommandComposer<GetUserSettingsCommand>

convertFromJSON()​

static convertFromJSON(msgType, data): Message

Defined in: src/common/web/core/messaging/Message.ts:93

Creates a message from JSON data.

Parameters​

msgType​

ConstructableMessage

The message type to construct.

data​

string

The JSON data string.

Returns​

Message

  • The created message.

Inherited from​

Command.convertFromJSON

define()​

static define(name): Function

Defined in: src/common/web/core/messaging/Message.ts:128

Defines a new message.

The decorator takes care of wrapping the new class as a dataclass, passing the correct message name to its constructor. It also registers the new message type in the global MessageTypesCatalog.

Examples:

    @Message.define("msg/command")
    class MyCommand extends Command {
        ...
    }

Parameters​

name​

string

The name of the message.

Returns​

Function

Inherited from​

Command.define

isProtected()​

static isProtected(): boolean

Defined in: src/common/web/core/messaging/Message.ts:108

The frontend never receives or issues protected messages.

Returns​

boolean

Inherited from​

Command.isProtected

messageName()​

static messageName(): string

Defined in: src/common/web/core/messaging/Message.ts:101

Retrieves the name of the message type on a message class basis.

Returns​

string

Inherited from​

Command.messageName