Unverified Commit 1bb19150 authored by Gabriel Engel's avatar Gabriel Engel Committed by gitbook-bot
Browse files

GitBook: [master] 9 pages modified

parent 6e6cd22d
......@@ -224,13 +224,13 @@
## API
* [Schema Definition](api/schema-definition/README.md)
* [User](api/schema-definition/user.md)
* [Room](api/schema-definition/the-room-object.md)
* [Message](api/schema-definition/the-message-object.md)
* [User](api/schema-definition/user.md)
* [Schema Definition v2 \(Draft\)](api/schema-definition-v2/README.md)
* [IUser](api/schema-definition-v2/iuser.md)
* [IRoom](api/schema-definition-v2/i-room.md)
* [IEvent](api/schema-definition-v2/i-event.md)
* [User](api/schema-definition-v2/user.md)
* [Room](api/schema-definition-v2/room.md)
* [Event](api/schema-definition-v2/event.md)
* [EventContext](api/schema-definition-v2/event-context.md)
* [EventTypeDescriptor](api/schema-definition-v2/event-type-descriptor.md)
* [EventMessageTypeDescriptor](api/schema-definition-v2/eventmessagetypedescriptor.md)
......
......@@ -29,7 +29,7 @@ export interface IEventDataMessage {
| Property | What is it? |
| :--- | :--- |
| t | The type descriptor of the message, more in [EventMessageTypeDescriptor](../eventmessagetypedescriptor.md) |
| u | This holds the user which emitted this message, you can see the definition in [IUser](../iuser.md) |
| u | This holds the user which emitted this message, you can see the definition in [IUser](../user.md) |
| msg | The actual message, the text |
| mentions | \[OPTIONAL\] Holds the user mentions related to this message |
| channels | \[OPTIONAL\] Holds the channel mentions related to this message |
......
......@@ -14,5 +14,5 @@ export interface IEventDataRoom {
| Property | What is it? |
| :--- | :--- |
| room | Holds an [IRoom](../i-room.md) interface, which is related to the legacy [Room](../../schema-definition/the-room-object.md) definition. |
| room | Holds an [IRoom](../room.md) interface, which is related to the legacy [Room](../../schema-definition/the-room-object.md) definition. |
......@@ -5,9 +5,9 @@ description: >-
events.
---
# IEvent
# Event
Typescript interface definition:
### Interface Definition
```typescript
interface IEvent<T extends EDataDefinition> {
......
......@@ -4,9 +4,9 @@ description: >-
the current event system state.
---
# IRoom
# Room
The interface definition is:
### Interface Definition
```typescript
export interface IRoom {
......
# User
### Interface Definition
```typescript
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment