1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[188],{28453:(e,s,n)=>{n.d(s,{R:()=>d,x:()=>i});var r=n(96540);const c={},o=r.createContext(c);function d(e){const s=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(o.Provider,{value:s},e.children)}},38584:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"reference/frontend/common/web/core/messaging/Command/classes/Command","title":"Class: Command","description":"Defined in14","source":"@site/docs/reference/frontend/common/web/core/messaging/Command/classes/Command.md","sourceDirName":"reference/frontend/common/web/core/messaging/Command/classes","slug":"/reference/frontend/common/web/core/messaging/Command/classes/Command","permalink":"/docs/reference/frontend/common/web/core/messaging/Command/classes/Command","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"frontendSidebar","previous":{"title":"common/web/core/messaging/Command","permalink":"/docs/reference/frontend/common/web/core/messaging/Command/"},"next":{"title":"common/web/core/messaging/CommandReply","permalink":"/docs/reference/frontend/common/web/core/messaging/CommandReply/"}}');var c=n(74848),o=n(28453);const d={},i="Class: Command",a={},l=[{value:"Extends",id:"extends",level:2},{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"Constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"name",id:"name",level:5},{value:"origin",id:"origin",level:5},{value:"sender",id:"sender",level:5},{value:"target",id:"target",level:5},{value:"hops",id:"hops",level:5},{value:"trace",id:"trace",level:5},{value:"apiKey",id:"apikey",level:5},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Properties",id:"properties",level:2},{value:"api_key",id:"api_key",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"hops",id:"hops-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"name",id:"name-1",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"origin",id:"origin-1",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"payload",id:"payload",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"sender",id:"sender-1",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"target",id:"target-1",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"trace",id:"trace-1",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"unique",id:"unique",level:3},{value:"Category",id:"category",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Accessors",id:"accessors",level:2},{value:"messageCategory",id:"messagecategory",level:3},{value:"Get Signature",id:"get-signature",level:4},{value:"Returns",id:"returns-1",level:5},{value:"Overrides",id:"overrides-1",level:4},{value:"Methods",id:"methods",level:2},{value:"convertToJSON()",id:"converttojson",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"convertFromJSON()",id:"convertfromjson",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"msgType",id:"msgtype",level:5},{value:"data",id:"data",level:5},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"define()",id:"define",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"name",id:"name-2",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"isProtected()",id:"isprotected",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-13",level:4}
1,{value:"messageName()",id:"messagename",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-14",level:4}];function t(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(s.header,{children:(0,c.jsx)(s.h1,{id:"class-command",children:"Class: Command"})}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Command.ts#L14",children:"src/common/web/core/messaging/Command.ts:14"})]}),"\n",(0,c.jsx)(s.p,{children:"A command message."}),"\n",(0,c.jsxs)(s.p,{children:["Commands are instructions that need to be ",(0,c.jsx)(s.em,{children:"executed"})," by the receiving component."]}),"\n",(0,c.jsxs)(s.p,{children:["Notes:\nCommands need to ",(0,c.jsx)(s.em,{children:"always"})," be replied by emitting a corresponding ",(0,c.jsx)(s.code,{children:"CommandReply"}),".\nThis reply is then automatically sent back to the original sender."]}),"\n",(0,c.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,c.jsxs)(s.ul,{children:["\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})})}),"\n"]}),"\n",(0,c.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,c.jsxs)(s.ul,{children:["\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/authorization/AuthorizationCommands/classes/RequestAuthorizationCommand",children:(0,c.jsx)(s.code,{children:"RequestAuthorizationCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/authorization/AuthorizationCommands/classes/RevokeAuthorizationCommand",children:(0,c.jsx)(s.code,{children:"RevokeAuthorizationCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/connector/ConnectorCommands/classes/ListConnectorsCommand",children:(0,c.jsx)(s.code,{children:"ListConnectorsCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/metadata/MetadataCommands/classes/GetMetadataProfilesCommand",children:(0,c.jsx)(s.code,{children:"GetMetadataProfilesCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/network/NetworkCommands/classes/PingCommand",children:(0,c.jsx)(s.code,{children:"PingCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectCommands/classes/ListProjectsCommand",children:(0,c.jsx)(s.code,{children:"ListProjectsCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectCommands/classes/CreateProjectCommand",children:(0,c.jsx)(s.code,{children:"CreateProjectCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectCommands/classes/UpdateProjectCommand",children:(0,c.jsx)(s.code,{children:"UpdateProjectCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectCommands/classes/MarkProjectLogbookSeenCommand",children:(0,c.jsx)(s.code,{children:"MarkProjectLogbookSeenCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectCommands/classes/DeleteProjectCommand",children:(0,c.jsx)(s.code,{children:"DeleteProjectCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectExportersCommands/classes/ListProjectExportersCommand",children:(0,c.jsx)(s.code,{children:"ListProjectExportersCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectExportersCommands/classes/ExportProjectCommand",children:(0,c.jsx)(s.code,{children:"ExportProjectCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectFeaturesCommands/classes/UpdateProjectFeaturesCommand",children:(0,c.jsx)(s.code,{children:"UpdateProjectFeaturesCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectJobCommands/classes/ListProjectJobsCommand",children:(0,c.jsx)(s.code,{children:"ListProjectJobsCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/project/ProjectJobCommands/classes/InitiateProjectJobCommand",children:(0,c.jsx)(s.code,{children:"InitiateProjectJobCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/resource/ResourceCommands/classes/AssignResourcesBrokerCommand",children:(0,c.jsx)(s.code,{children:"AssignResourcesBrokerCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/resource/ResourceCommands/classes/ListResourcesCommand",children:(0,c.jsx)(s.code,{children:"ListResourcesCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/resource/ResourceCommands/classes/GetResourceCommand",children:(0,c.jsx)(s.code,{children:"GetResourceCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/session/SessionCommands/classes/GetSessionValueCommand",children:(0,c.jsx)(s.code,{children:"GetSessionValueCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/session/SessionCommands/classes/SetSessionValueCommand",children:(0,c.jsx)(s.code,{children:"SetSessionValueCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/user/UserCommands/classes/AuthenticateUserCommand",children:(0,c.jsx)(s.code,{children:"AuthenticateUserCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/user/UserCommands/classes/GetUserSettingsCommand",children:(0,c.jsx)(s.code,{children:"GetUserSettingsCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/user/UserCommands/classes/SetUserSettingsCommand",children:(0,c.jsx)(s.code,{children:"SetUserSettingsCommand"})})}),"\n",(0,c.jsx)(s.li,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/api/user/UserCommands/classes/ListUserAuthorizationsCommand",children:(0,c.jsx)(s.code,{children:"ListUserAuthorizationsCommand"})})}),"\n"]}),"\n",(0,c.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,c.jsx)(s.h3,{id:"constructor",children:"Constructor"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"new Command"}),"(",(0,c.jsx)(s.code,{children:"name"}),", ",(0,c.jsx)(s.code,{children:"origin"}),", ",(0,c.jsx)(s.code,{children:"sender"}),", ",(0,c.jsx)(s.code,{children:"target"}),", ",(0,c.jsx)(s.code,{children:"hops"}),", ",(0,c.jsx)(s.code,{children:"trace"}),", ",(0,c.jsx)(s.code,{children:"apiKey"}),"): ",(0,c.jsx)(s.code,{children:"Command"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L63",children:"src/common/web/core/messaging/Message.ts:63"})]}),"\n",(0,c.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsx)(s.h5,{id:"name",children:"name"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.p,{children:"The name of the message."}),"\n",(0,c.jsx)(s.h5,{id:"origin",children:"origin"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})})}),"\n",(0,c.jsx)(s.p,{children:"The initial source component of the message."}),"\n",(0,c.jsx)(s.h5,{id:"sender",children:"sender"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})})}),"\n",(0,c.jsx)(s.p,{children:"The component from where the message came from."}),"\n",(0,c.jsx)(s.h5,{id:"target",children:"target"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Channel/classe
1s/Channel",children:(0,c.jsx)(s.code,{children:"Channel"})})}),"\n",(0,c.jsx)(s.p,{children:"Where the message should go to."}),"\n",(0,c.jsx)(s.h5,{id:"hops",children:"hops"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})}),"[] = ",(0,c.jsx)(s.code,{children:"[]"})]}),"\n",(0,c.jsx)(s.p,{children:"A list of components the message was sent through."}),"\n",(0,c.jsx)(s.h5,{id:"trace",children:"trace"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"string"})," = ",(0,c.jsx)(s.code,{children:"..."})]}),"\n",(0,c.jsx)(s.p,{children:"A unique trace identifying messages that logically belong together."}),"\n",(0,c.jsx)(s.h5,{id:"apikey",children:"apiKey"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"string"})," = ",(0,c.jsx)(s.code,{children:'""'})]}),"\n",(0,c.jsx)(s.p,{children:"An optional API key to access protected resources."}),"\n",(0,c.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"Command"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#constructor",children:(0,c.jsx)(s.code,{children:"constructor"})})]}),"\n",(0,c.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(s.h3,{id:"api_key",children:"api_key"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"api_key"}),": ",(0,c.jsx)(s.code,{children:"string"})," = ",(0,c.jsx)(s.code,{children:'""'})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L50",children:"src/common/web/core/messaging/Message.ts:50"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#api_key",children:(0,c.jsx)(s.code,{children:"api_key"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"hops-1",children:"hops"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"hops"}),": ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})}),"[] = ",(0,c.jsx)(s.code,{children:"[]"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L46",children:"src/common/web/core/messaging/Message.ts:46"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#hops",children:(0,c.jsx)(s.code,{children:"hops"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"name-1",children:"name"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"name"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L33",children:"src/common/web/core/messaging/Message.ts:33"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classe
1s/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#name",children:(0,c.jsx)(s.code,{children:"name"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"origin-1",children:"origin"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"origin"}),": ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L36",children:"src/common/web/core/messaging/Message.ts:36"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#origin",children:(0,c.jsx)(s.code,{children:"origin"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"payload",children:"payload"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"payload"}),": ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/MessagePayload/classes/MessagePayload",children:(0,c.jsx)(s.code,{children:"MessagePayload"})})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L52",children:"src/common/web/core/messaging/Message.ts:52"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#payload",children:(0,c.jsx)(s.code,{children:"payload"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"sender-1",children:"sender"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"sender"}),": ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/utils/UnitID/classes/UnitID",children:(0,c.jsx)(s.code,{children:"UnitID"})})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L39",children:"src/common/web/core/messaging/Message.ts:39"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#sender",children:(0,c.jsx)(s.code,{children:"sender"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"target-1",children:"target"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"target"}),": ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Channel/classes/Channel",children:(0,c.jsx)(s.code,{children:"Channel"})})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L42",children:"src/common/web/core/messaging/Message.ts:42"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classe
1s/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#target",children:(0,c.jsx)(s.code,{children:"target"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"trace-1",children:"trace"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"trace"}),": ",(0,c.jsx)(s.code,{children:"string"})," = ",(0,c.jsx)(s.code,{children:'""'})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L48",children:"src/common/web/core/messaging/Message.ts:48"})]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#trace",children:(0,c.jsx)(s.code,{children:"trace"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"unique",children:"unique"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.strong,{children:"unique"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Command.ts#L17",children:"src/common/web/core/messaging/Command.ts:17"})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"category",children:"Category"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"readonly"})," ",(0,c.jsx)(s.code,{children:"static"})," ",(0,c.jsx)(s.strong,{children:"Category"}),": ",(0,c.jsx)(s.code,{children:"string"})," = ",(0,c.jsx)(s.code,{children:'"Command"'})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Command.ts#L15",children:"src/common/web/core/messaging/Command.ts:15"})]}),"\n",(0,c.jsx)(s.h4,{id:"overrides",children:"Overrides"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#category",children:(0,c.jsx)(s.code,{children:"Category"})})]}),"\n",(0,c.jsx)(s.h2,{id:"accessors",children:"Accessors"}),"\n",(0,c.jsx)(s.h3,{id:"messagecategory",children:"messageCategory"}),"\n",(0,c.jsx)(s.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"get"})," ",(0,c.jsx)(s.strong,{children:"messageCategory"}),"(): ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Command.ts#L22",children:"src/common/web/core/messaging/Command.ts:22"})]}),"\n",(0,c.jsx)(s.p,{children:"Gets the global message category."}),"\n",(0,c.jsx)(s.h5,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#messagecategory",children:(0,c.jsx)(s.code,{children:"messageCategory"})})]}),"\n",(0,c.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(s.h3,{id:"converttojson",children:"convertToJSON()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"convertToJSON"}),"(): ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L76",children:"src/common/web/core/messaging/Message.ts:76"})]}),"\n",(0,c.jsx)(s.p,{children:"Converts this message to JSON."}),"\n",(0,c.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classe
1s/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#converttojson",children:(0,c.jsx)(s.code,{children:"convertToJSON"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"tostring",children:"toString()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"toString"}),"(): ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L154",children:"src/common/web/core/messaging/Message.ts:154"})]}),"\n",(0,c.jsx)(s.p,{children:"Gets the string representation of this message."}),"\n",(0,c.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#tostring",children:(0,c.jsx)(s.code,{children:"toString"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"convertfromjson",children:"convertFromJSON()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"static"})," ",(0,c.jsx)(s.strong,{children:"convertFromJSON"}),"(",(0,c.jsx)(s.code,{children:"msgType"}),", ",(0,c.jsx)(s.code,{children:"data"}),"): ",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L93",children:"src/common/web/core/messaging/Message.ts:93"})]}),"\n",(0,c.jsx)(s.p,{children:"Creates a message from JSON data."}),"\n",(0,c.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,c.jsx)(s.h5,{id:"msgtype",children:"msgType"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/interfaces/ConstructableMessage",children:(0,c.jsx)(s.code,{children:"ConstructableMessage"})})}),"\n",(0,c.jsx)(s.p,{children:"The message type to construct."}),"\n",(0,c.jsx)(s.h5,{id:"data",children:"data"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.p,{children:"The JSON data string."}),"\n",(0,c.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})})}),"\n",(0,c.jsxs)(s.ul,{children:["\n",(0,c.jsx)(s.li,{children:"The created message."}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#convertfromjson",children:(0,c.jsx)(s.code,{children:"convertFromJSON"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"define",children:"define()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"static"})," ",(0,c.jsx)(s.strong,{children:"define"}),"(",(0,c.jsx)(s.code,{children:"name"}),"): ",(0,c.jsx)(s.code,{children:"Function"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L128",children:"src/common/web/core/messaging/Message.ts:128"})]}),"\n",(0,c.jsx)(s.p,{children:"Defines a new message."}),"\n",(0,c.jsxs)(s.p,{children:["The decorator takes care of wrapping the new class as a dataclass, passing the correct message\nname to its constructor. It also registers the new message type in the global ",(0,c.jsx)(s.code,{children:"MessageTypesCatalog"}),"."]}),"\n",(0,c.jsx)(s.p,{children:"Examples:"}),"\n",(0,c.jsx)(s.pre,{children:(0,c.jsx)(s.code,{children:' @Message.define("msg/command")\n class MyCommand extends Command {\n ...\n }\n'})}),"\n",(0,c.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,c.jsx)(s.h5,{id:"name-2",children:"name"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.p,{children:"The name of the message."}),"\n",(0,c.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"Function"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classe
1s/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#define",children:(0,c.jsx)(s.code,{children:"define"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"isprotected",children:"isProtected()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"static"})," ",(0,c.jsx)(s.strong,{children:"isProtected"}),"(): ",(0,c.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L108",children:"src/common/web/core/messaging/Message.ts:108"})]}),"\n",(0,c.jsx)(s.p,{children:"The frontend never receives or issues protected messages."}),"\n",(0,c.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"boolean"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#isprotected",children:(0,c.jsx)(s.code,{children:"isProtected"})})]}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"messagename",children:"messageName()"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"static"})," ",(0,c.jsx)(s.strong,{children:"messageName"}),"(): ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(s.p,{children:["Defined in: ",(0,c.jsx)(s.a,{href:"https://github.com/Sciebo-RDS/rds-ng/blob/2a995681a258856d45068ae2d4915f1a8336b9da/src/common/web/core/messaging/Message.ts#L101",children:"src/common/web/core/messaging/Message.ts:101"})]}),"\n",(0,c.jsx)(s.p,{children:"Retrieves the name of the message type on a message class basis."}),"\n",(0,c.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.code,{children:"string"})}),"\n",(0,c.jsx)(s.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message",children:(0,c.jsx)(s.code,{children:"Message"})}),".",(0,c.jsx)(s.a,{href:"/docs/reference/frontend/common/web/core/messaging/Message/classes/Message#messagename",children:(0,c.jsx)(s.code,{children:"messageName"})})]})]})}function h(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,c.jsx)(s,{...e,children:(0,c.jsx)(t,{...e})}):t(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.