diff --git a/docs/protocol/serialization/signalproxy_objects.md b/docs/protocol/serialization/signalproxy_objects.md index 8e09ec9f5d3261e44cde31de9ef1317d2c817d3b..26b3abc24d9e1d60dc6ec7e362495dc704451133 100644 --- a/docs/protocol/serialization/signalproxy_objects.md +++ b/docs/protocol/serialization/signalproxy_objects.md @@ -60,6 +60,10 @@ is translated into ## AliasManager +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -109,6 +113,10 @@ interface AliasManager { ## BacklogManager +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -171,6 +179,10 @@ fields. For the same reason it also does **not** support the otherwise standard ## BufferSyncer +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -235,6 +247,13 @@ interface BufferSyncer { ## BufferViewConfig +**ObjectName** + +The objectName of a BufferViewConfig is the string representation of the +bufferViewId. + +Example: `0` + **Runtime** ```typescript @@ -333,6 +352,10 @@ interface BufferViewConfig { ## BufferViewManager +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -371,6 +394,13 @@ interface BufferViewManager { ## CertManager +**ObjectName** + +The objectName of a CertManager is the string representation of the identityId +of the Identity it belongs to. + +Example: `2` + **Runtime** ```typescript @@ -411,6 +441,10 @@ interface CertManager { ## CoreInfo +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -478,6 +512,10 @@ interface CoreInfo { !!! danger This part is still unfinished. +**ObjectName** + +As this object is a singleton, the objectName is always "DccConfig" + **Runtime** ```typescript @@ -496,6 +534,10 @@ interface DccConfig { ## HighlightRuleManager +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -594,6 +636,12 @@ interface HighlightRuleManager { ## Identity +**ObjectName** + +The objectName of an Identity is the string representation of the identityId. + +Example: `2` + **Runtime** ```typescript @@ -686,6 +734,10 @@ interface Identity { ## IgnoreListManager +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -776,6 +828,14 @@ interface IgnoreListManager { ## IrcChannel +**ObjectName** + +The objectName of an IrcChannel is the string representation of the networkId of +the network it belongs to, followed by a "/", followed by the name of the +channel. + +Example: `4/#quassel` + **Runtime** ```typescript @@ -833,6 +893,10 @@ interface IrcChannel { !!! danger This part is still unfinished. +**ObjectName** + +As this object is a singleton, the objectName is always "" + **Runtime** ```typescript @@ -851,6 +915,13 @@ interface IrcListHelper { ## IrcUser +**ObjectName** + +The objectName of an IrcUser is the string representation of the networkId of +the network it belongs to, followed by a "/", followed by the nick of the user. + +Example: `4/justJanne` + **Runtime** ```typescript @@ -935,6 +1006,12 @@ interface IrcUser { ## Network +**ObjectName** + +The objectName of a Network is the string representation of the networkId. + +Example: `4` + **Runtime** ```typescript @@ -1137,6 +1214,10 @@ interface Network { ## NetworkInfo +**ObjectName** + +As this object is a singleton, the objectName is always "GlobalNetworkConfig" + **Runtime** ```typescript