Skip to content
Snippets Groups Projects
Verified Commit eeb284d1 authored by Janne Mareike Koschinski's avatar Janne Mareike Koschinski
Browse files

Improve documentation on signalproxy objects

parent 5b658874
No related branches found
No related tags found
No related merge requests found
...@@ -60,6 +60,10 @@ is translated into ...@@ -60,6 +60,10 @@ is translated into
## AliasManager ## AliasManager
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -109,6 +113,10 @@ interface AliasManager { ...@@ -109,6 +113,10 @@ interface AliasManager {
## BacklogManager ## BacklogManager
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -171,6 +179,10 @@ fields. For the same reason it also does **not** support the otherwise standard ...@@ -171,6 +179,10 @@ fields. For the same reason it also does **not** support the otherwise standard
## BufferSyncer ## BufferSyncer
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -235,6 +247,13 @@ interface BufferSyncer { ...@@ -235,6 +247,13 @@ interface BufferSyncer {
## BufferViewConfig ## BufferViewConfig
**ObjectName**
The objectName of a BufferViewConfig is the string representation of the
bufferViewId.
Example: `0`
**Runtime** **Runtime**
```typescript ```typescript
...@@ -333,6 +352,10 @@ interface BufferViewConfig { ...@@ -333,6 +352,10 @@ interface BufferViewConfig {
## BufferViewManager ## BufferViewManager
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -371,6 +394,13 @@ interface BufferViewManager { ...@@ -371,6 +394,13 @@ interface BufferViewManager {
## CertManager ## CertManager
**ObjectName**
The objectName of a CertManager is the string representation of the identityId
of the Identity it belongs to.
Example: `2`
**Runtime** **Runtime**
```typescript ```typescript
...@@ -411,6 +441,10 @@ interface CertManager { ...@@ -411,6 +441,10 @@ interface CertManager {
## CoreInfo ## CoreInfo
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -478,6 +512,10 @@ interface CoreInfo { ...@@ -478,6 +512,10 @@ interface CoreInfo {
!!! danger !!! danger
This part is still unfinished. This part is still unfinished.
**ObjectName**
As this object is a singleton, the objectName is always "DccConfig"
**Runtime** **Runtime**
```typescript ```typescript
...@@ -496,6 +534,10 @@ interface DccConfig { ...@@ -496,6 +534,10 @@ interface DccConfig {
## HighlightRuleManager ## HighlightRuleManager
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -594,6 +636,12 @@ interface HighlightRuleManager { ...@@ -594,6 +636,12 @@ interface HighlightRuleManager {
## Identity ## Identity
**ObjectName**
The objectName of an Identity is the string representation of the identityId.
Example: `2`
**Runtime** **Runtime**
```typescript ```typescript
...@@ -686,6 +734,10 @@ interface Identity { ...@@ -686,6 +734,10 @@ interface Identity {
## IgnoreListManager ## IgnoreListManager
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -776,6 +828,14 @@ interface IgnoreListManager { ...@@ -776,6 +828,14 @@ interface IgnoreListManager {
## IrcChannel ## 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** **Runtime**
```typescript ```typescript
...@@ -833,6 +893,10 @@ interface IrcChannel { ...@@ -833,6 +893,10 @@ interface IrcChannel {
!!! danger !!! danger
This part is still unfinished. This part is still unfinished.
**ObjectName**
As this object is a singleton, the objectName is always ""
**Runtime** **Runtime**
```typescript ```typescript
...@@ -851,6 +915,13 @@ interface IrcListHelper { ...@@ -851,6 +915,13 @@ interface IrcListHelper {
## IrcUser ## 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** **Runtime**
```typescript ```typescript
...@@ -935,6 +1006,12 @@ interface IrcUser { ...@@ -935,6 +1006,12 @@ interface IrcUser {
## Network ## Network
**ObjectName**
The objectName of a Network is the string representation of the networkId.
Example: `4`
**Runtime** **Runtime**
```typescript ```typescript
...@@ -1137,6 +1214,10 @@ interface Network { ...@@ -1137,6 +1214,10 @@ interface Network {
## NetworkInfo ## NetworkInfo
**ObjectName**
As this object is a singleton, the objectName is always "GlobalNetworkConfig"
**Runtime** **Runtime**
```typescript ```typescript
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment