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

GitBook: [master] 17 pages modified

parent a075bec9
......@@ -223,7 +223,9 @@
## API
* [Schema Definition](api/schema-definition.md)
* [Schema Definition](api/schema-definition/README.md)
* [The Room Object](api/schema-definition/the-room-object.md)
* [The Message Object](api/schema-definition/the-message-object.md)
* [Realtime API](api/realtime-api/README.md)
* [Method Calls](api/realtime-api/method-calls/README.md)
* [Archive Rooms](api/realtime-api/method-calls/archive-rooms.md)
......@@ -267,11 +269,11 @@
* [User Presence](api/realtime-api/method-calls/user-presence.md)
* [Two Factor Authentication](api/realtime-api/2fa.md)
* [Livechat Realtime API](api/realtime-api/livechat-api/README.md)
* [Method: livechat:getInitialData](api/realtime-api/livechat-api/getinitialdata.md)
* [Method: livechat:registerGuest](api/realtime-api/livechat-api/registerguest.md)
* [Method: livechat:sendOfflineMessage](api/realtime-api/livechat-api/sendofflinemessage.md)
* [Method: sendMessageLivechat](api/realtime-api/livechat-api/sendmessagelivechat.md)
* [Method: stream-livechat-room](api/realtime-api/livechat-api/streamlivechatroom.md)
* [livechat:getInitialData](api/realtime-api/livechat-api/getinitialdata.md)
* [livechat:registerGuest](api/realtime-api/livechat-api/registerguest.md)
* [livechat:sendOfflineMessage](api/realtime-api/livechat-api/sendofflinemessage.md)
* [sendMessageLivechat](api/realtime-api/livechat-api/sendmessagelivechat.md)
* [stream-livechat-room](api/realtime-api/livechat-api/streamlivechatroom.md)
* [Subscriptions](api/realtime-api/subscriptions/README.md)
* [stream-notify-all](api/realtime-api/subscriptions/stream-notify-all.md)
* [stream-notify-logged](api/realtime-api/subscriptions/stream-notify-logged.md)
......@@ -279,8 +281,6 @@
* [stream-notify-room](api/realtime-api/subscriptions/stream-notify-room.md)
* [stream-notify-user](api/realtime-api/subscriptions/stream-notify-user.md)
* [stream-room-messages](api/realtime-api/subscriptions/stream-room-messages.md)
* [The Message Object](api/realtime-api/the-message-object.md)
* [The Room Object](api/realtime-api/the-room-object.md)
* [REST API](api/rest-api/README.md)
* [Avatars](api/rest-api/avatars.md)
* [Methods](api/rest-api/methods/README.md)
......
# Method: livechat:getInitialData
# livechat:getInitialData
## DDP message
......
# Method: livechat:registerGuest
# livechat:registerGuest
## DDP message
......
# Method: sendMessageLivechat
# sendMessageLivechat
## DDP message
......
# Method: livechat:sendOfflineMessage
# livechat:sendOfflineMessage
## DDP message
......
# Method: stream-livechat-room
# stream-livechat-room
## DDP message
......
......@@ -10,7 +10,7 @@ The `remove` field is a collection of room id identifying the rooms that were re
## Update field
The `update` field is a collection of `room` and its content varies according to the `room type`. You can read more about the `room` object on [its own page](../the-room-object.md).
The `update` field is a collection of `room` and its content varies according to the `room type`. You can read more about the `room` object on [its own page](../../schema-definition/the-room-object.md).
## Example call
......
......@@ -11,7 +11,7 @@ This method accepts 4 parameters in the following order:
The result is composed of the `messages` collection and the `unreadNotLoaded`counter.
The `message` object is fairly complex and have [its own section describing it](../the-message-object.md). The `unreadNotLoaded` counts the quantity of unread messages not loaded by the call.
The `message` object is fairly complex and have [its own section describing it](../../schema-definition/the-message-object.md). The `unreadNotLoaded` counts the quantity of unread messages not loaded by the call.
Examples:
......
......@@ -10,7 +10,7 @@ Pinning a message allows administrators and owners of rooms to easily store mess
## Example Call
The only parameter that needs to be passed in is the [Message Object](../the-message-object.md) and as of release `0.46` you need to send the entire message object otherwise an internal error will happen \([fixed via pull request \#5087](https://github.com/RocketChat/Rocket.Chat/pull/5087)\).
The only parameter that needs to be passed in is the [Message Object](../../schema-definition/the-message-object.md) and as of release `0.46` you need to send the entire message object otherwise an internal error will happen \([fixed via pull request \#5087](https://github.com/RocketChat/Rocket.Chat/pull/5087)\).
```javascript
{
......@@ -23,7 +23,7 @@ The only parameter that needs to be passed in is the [Message Object](../the-mes
## Example Response
The response of a message being pinned is a new chat message which contains the broadcast of the message pinning. See [Message Object Details](../the-message-object.md) for information about the response format.
The response of a message being pinned is a new chat message which contains the broadcast of the message pinning. See [Message Object Details](../../schema-definition/the-message-object.md) for information about the response format.
```javascript
{
......@@ -53,6 +53,6 @@ The response of a message being pinned is a new chat message which contains the
## See Also
* [The Message Object](../the-message-object.md)
* [The Message Object](../../schema-definition/the-message-object.md)
* [Pinning Messages User Guide](../../../guides/user-guides/messaging.md)
......@@ -35,7 +35,7 @@ For sending a file we now recommend using the rest api:
## See Also
* [The Message Object](../the-message-object.md)
* [The Message Object](../../schema-definition/the-message-object.md)
* [Delete Message Method](delete-message.md)
* [Update Message Method](update-message.md)
......@@ -10,7 +10,7 @@ Updating a message is what should be called when a user "edits" a message, passi
## Example Call
The only parameter that needs to be passed in is the [Message Object](../the-message-object.md) which contains the updated message properties, such as the text.
The only parameter that needs to be passed in is the [Message Object](../../schema-definition/the-message-object.md) which contains the updated message properties, such as the text.
```javascript
{
......@@ -37,7 +37,7 @@ As mentioned in requirements, you must be logged in to be able to edit a message
## See Also
* [The Message Object](../the-message-object.md)
* [The Message Object](../../schema-definition/the-message-object.md)
* [Send Message Method](send-message.md)
* [Delete Message Method](delete-message.md)
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