From 29b58e6dc4b6dfee9056e1c5d0c06fc69c31fee9 Mon Sep 17 00:00:00 2001 From: Faria Masood Date: Tue, 7 Nov 2023 17:19:32 +0000 Subject: [PATCH] GITBOOK-1151: Omnichannel intro update --- SUMMARY.md | 18 +++++++++--------- .../email-event-interfaces.md | 0 .../examples.md | 0 .../livechat-event-interfaces.md | 0 .../message-event-interfaces.md | 0 .../room-event-interfaces.md | 0 .../settings-event-interfaces.md | 0 .../uploads-event-interfaces.md | 0 .../users-event-interfaces.md | 0 .../event-interfaces.md} | 2 +- .../rest-api/endpoints/omnichannel/README.md | 5 +++++ 11 files changed, 15 insertions(+), 10 deletions(-) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/email-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/examples.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/livechat-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/message-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/room-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/settings-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/uploads-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers => event-interfaces}/users-event-interfaces.md (100%) rename apps-engine/{event-interfaces-and-handlers/README.md => fundamentals-of-apps/event-interfaces.md} (96%) diff --git a/SUMMARY.md b/SUMMARY.md index fa22dd40..351bd283 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -94,15 +94,15 @@ * [App Development Lifecycle](apps-engine/understanding-app-lifecycle.md) * [App Configuration](apps-engine/app-configuration.md) * [App Internationalization](apps-engine/app-internationalization.md) -* [Event Interfaces and Handlers](apps-engine/event-interfaces-and-handlers/README.md) - * [Email - Event Interfaces](apps-engine/event-interfaces-and-handlers/email-event-interfaces.md) - * [Livechat - Event Interfaces](apps-engine/event-interfaces-and-handlers/livechat-event-interfaces.md) - * [Message - Event Interfaces](apps-engine/event-interfaces-and-handlers/message-event-interfaces.md) - * [Room - Event Interfaces](apps-engine/event-interfaces-and-handlers/room-event-interfaces.md) - * [Settings - Event Interfaces](apps-engine/event-interfaces-and-handlers/settings-event-interfaces.md) - * [Uploads - Event Interfaces](apps-engine/event-interfaces-and-handlers/uploads-event-interfaces.md) - * [Users - Event Interfaces](apps-engine/event-interfaces-and-handlers/users-event-interfaces.md) - * [Examples](apps-engine/event-interfaces-and-handlers/examples.md) +* [Event Interfaces and Handlers](apps-engine/fundamentals-of-apps/event-interfaces.md) + * [Email - Event Interfaces](apps-engine/event-interfaces/email-event-interfaces.md) + * [Livechat - Event Interfaces](apps-engine/event-interfaces/livechat-event-interfaces.md) + * [Message - Event Interfaces](apps-engine/event-interfaces/message-event-interfaces.md) + * [Room - Event Interfaces](apps-engine/event-interfaces/room-event-interfaces.md) + * [Settings - Event Interfaces](apps-engine/event-interfaces/settings-event-interfaces.md) + * [Uploads - Event Interfaces](apps-engine/event-interfaces/uploads-event-interfaces.md) + * [Users - Event Interfaces](apps-engine/event-interfaces/users-event-interfaces.md) + * [Examples](apps-engine/event-interfaces/examples.md) * [Apps-Engine User Interface](apps-engine/user-interface/README.md) * [Opening the Contextual Bar](apps-engine/user-interface/uikit/opening-the-contextual-bar.md) * [Building blocks](apps-engine/user-interface/uikit/building-blocks.md) diff --git a/apps-engine/event-interfaces-and-handlers/email-event-interfaces.md b/apps-engine/event-interfaces/email-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/email-event-interfaces.md rename to apps-engine/event-interfaces/email-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/examples.md b/apps-engine/event-interfaces/examples.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/examples.md rename to apps-engine/event-interfaces/examples.md diff --git a/apps-engine/event-interfaces-and-handlers/livechat-event-interfaces.md b/apps-engine/event-interfaces/livechat-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/livechat-event-interfaces.md rename to apps-engine/event-interfaces/livechat-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/message-event-interfaces.md b/apps-engine/event-interfaces/message-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/message-event-interfaces.md rename to apps-engine/event-interfaces/message-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/room-event-interfaces.md b/apps-engine/event-interfaces/room-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/room-event-interfaces.md rename to apps-engine/event-interfaces/room-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/settings-event-interfaces.md b/apps-engine/event-interfaces/settings-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/settings-event-interfaces.md rename to apps-engine/event-interfaces/settings-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/uploads-event-interfaces.md b/apps-engine/event-interfaces/uploads-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/uploads-event-interfaces.md rename to apps-engine/event-interfaces/uploads-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/users-event-interfaces.md b/apps-engine/event-interfaces/users-event-interfaces.md similarity index 100% rename from apps-engine/event-interfaces-and-handlers/users-event-interfaces.md rename to apps-engine/event-interfaces/users-event-interfaces.md diff --git a/apps-engine/event-interfaces-and-handlers/README.md b/apps-engine/fundamentals-of-apps/event-interfaces.md similarity index 96% rename from apps-engine/event-interfaces-and-handlers/README.md rename to apps-engine/fundamentals-of-apps/event-interfaces.md index 88793ffc..c2a74ccb 100644 --- a/apps-engine/event-interfaces-and-handlers/README.md +++ b/apps-engine/fundamentals-of-apps/event-interfaces.md @@ -46,4 +46,4 @@ Here is an explanation of the handlers: In the main class of your app, the class name extends `App`. This tells the Apps-Engine that `App` is the main class. To use events, the app must implement the event interfaces and this is done by using the keyword implements and the name of the events, comma separated. -In the following sections, you will find the event interfaces supported by Rocket.Chat. The event interfaces are grouped based on the events such as — email, livechat, messages, rooms, users, and so on. You will also find [examples](examples.md) of how these interfaces can be implemented. +In the following sections, you will find the event interfaces supported by Rocket.Chat. The event interfaces are grouped based on the events such as — email, livechat, messages, rooms, users, and so on. You will also find [examples](../event-interfaces/examples.md) of how these interfaces can be implemented. diff --git a/reference/api/rest-api/endpoints/omnichannel/README.md b/reference/api/rest-api/endpoints/omnichannel/README.md index 8613b0e4..2401b9e6 100644 --- a/reference/api/rest-api/endpoints/omnichannel/README.md +++ b/reference/api/rest-api/endpoints/omnichannel/README.md @@ -2,6 +2,11 @@ With the Rocket.Chat [Omnichannel](https://docs.rocket.chat/use-rocket.chat/omnichannel) feature, you can talk to your customers and website visitors, regardless of the channel they choose to connect with you. +The Omnichannel endpoints are of two types: authenticated and non-authenticated. + +* **Endpoints requiring authentication:** The workspace admins and managers use the endpoints that require authentication with a login method. +* **Endpoints not requiring authentication:** Visitors can use the endpoints that require no authentication. These endpoints require a visitor `token` which is like an authentication parameter for visitors. Visitors can [register themselves](livechat-endpoints/visitor/register-a-new-livechat-visitor.md) by providing a random unique string as the `token` which can be used for other such endpoints. + The endpoints in this section are:
livechat-endpointslivechat-endpoints
voice-channel-endpointsvoice-channel-endpoints
canned-responsescanned-responses