Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Q
quasseldroid-docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Janne Mareike Koschinski
quasseldroid-docs
Commits
eeb284d1
Verified
Commit
eeb284d1
authored
5 years ago
by
Janne Mareike Koschinski
Browse files
Options
Downloads
Patches
Plain Diff
Improve documentation on signalproxy objects
parent
5b658874
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/protocol/serialization/signalproxy_objects.md
+81
-0
81 additions, 0 deletions
docs/protocol/serialization/signalproxy_objects.md
with
81 additions
and
0 deletions
docs/protocol/serialization/signalproxy_objects.md
+
81
−
0
View file @
eeb284d1
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment