Skip to content

Commit

Permalink
Last major update to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnereese committed Jul 30, 2021
1 parent 4e7428f commit bb49bd5
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 32 deletions.
29 changes: 1 addition & 28 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,3 @@
# TODO list for interactive messaging documentation

* Update all code samples to use Adaptive Cards
* Update quick start guides with new "detailed instructions."
* Clarify differences between subscribing to bot events and interactive message events
* Have paco update sample bot apps with Adaptive Cards
* Clarify post titles: where they appear (bottom) and how they are used (notifications)

# Questions

* When you post a response asynchronously, what OAuth token do I use?
* How do developers authorize/obtain an access key to update messages asynchronously?
(for notification apps only)

# New files to populate

* docs/team-messaging/adaptive-cards/containers.md
* docs/team-messaging/adaptive-cards/static-elements.md
* docs/team-messaging/adaptive-cards/input-elements.md
* docs/team-messaging/adaptive-cards/actions.md
* docs/team-messaging/adaptive-cards/outbound-webhooks.md
* docs/team-messaging/bots/events.md
* docs/team-messaging/events/interactive-messages.md
* docs/team-messaging/manual/permissions.md
* docs/team-messaging/posting/index.md

# Redirects to put in place
team-messaging/manual/node/ -> team-messaging/bots/node/
team-messaging/manual/local-bots/ -> team-messaging/bots/walkthrough/
Expand All @@ -42,6 +16,5 @@ team-messaging/manual/webhook-posting.png -> team-messaging/incoming-webhooks/we
team-messaging/manual/posting-cards/ -> team-messaging/posting/cards/
team-messaging/manual/attaching-files/ -> team-messaging/posting/file-uploads/
team-messaging/manual/posting/ -> team-messaging/posting/rest-api/

team-messaging/manual/formatting/ -> team-messaging/posting/incoming-webhooks/
team-messaging/manual/posting-images/ -> ???
team-messaging/manual/posting-images/ -> team-messaging/adaptive-cards/
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 64 additions & 2 deletions docs/team-messaging/adaptive-cards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,72 @@

Adaptive Cards allows developers to implement richly formatted and interactive messages in team messaging, including form elements, buttons, and more.

!!! danger "TODO - screenshot of an adaptive card"
<div class="row">
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./basic-columns.png">
<figcaption class="figure-caption text-center">Multi-column layouts</figcaption>
</figure>
</div>
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./input-elements.png">
<figcaption class="figure-caption text-center">Input elements and forms</figcaption>
</figure>
</div>
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./rich-text.png">
<figcaption class="figure-caption text-center">Richly formatted text</figcaption>
</figure>
</div>
</div>

RingCentral implements the [Adaptive Card framework](https://adaptivecards.io) version 1.3. Originally developed by Microsoft, this open source framework aids developers with the design and development of richly formatted and interactive messages common to team chat and messaging services.

This means that if you have developed integrations for Microsoft Teams, the level of effort associated with adapting your integration for RingCentral MVP is greatly reduced.

## Designing your cards
## Use great design tools to design your cards

Among the many benefits of Adaptive Cards, are the robust set of tools made available through the broader Adaptive Card community to help developer design and implement cards for almost any use case. First, there is a [large library](https://adaptivecards.io/samples/) of pre-made adaptive cards from which to choose, including:

<div class="row">
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./itinerary.png">
<figcaption class="figure-caption text-center">Flight itineraries</figcaption>
</figure>
</div>
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./video.png">
<figcaption class="figure-caption text-center">Videos and media</figcaption>
</figure>
</div>
<div class="col">
<figure class="figure">
<img class="img-fluid figure-img" src="./expense-report-summ.png">
<figcaption class="figure-caption text-center">The dreaded expense report</figcaption>
</figure>
</div>
</div>

...with many more to choose from.

And if you cannot find a pre-made template to suit your needs, an [Adaptive Card designer](https://adaptivecards.io/designer/) also exists to help you design a card to your exact specifications. This tool makes it possible for technical and non-technical people alike to create cards with ease, and does not require users to first understand the [Adaptive Card schema](https://adaptivecards.io/explorer/). Finally, using the design tool, you can also preview your cards and its interactive elements.

* Learn more about [Adaptive card layouts and design](./containers/)

## Build smart and interactive messages

Adaptive Cards can also be embued with behaviors to make them more interactive and intelligent. Create cards with built-in forms. Have forms that react to user input, showing and hiding fields depending upon what is appropriate. Create cards that trigger events and actions like opening a web browser, submitting form contents, revealing other cards.

* Learn more about [Adaptive card actions and interactive elements](./actions/)

## Use Adaptive Cards in all kinds of applications

Adaptive Cards can be used in any number of different RingCentral applications, including:

* [Bots](./bots/walkthrough)
* [Add-ins](./add-ins/)
* [REST API-based apps](./posting/rest-api/)
Binary file added docs/team-messaging/adaptive-cards/itinerary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/team-messaging/adaptive-cards/video.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: Developing with RingCentral
site_url: https://github.com/ringcentral/ringcentral-api-docs
site_favicon: favicon.ico
#site_favicon: favicon.ico
repo_url: https://github.com/ringcentral/ringcentral-api-docs
edit_uri: tree/master/docs
docs_dir: docs
Expand Down Expand Up @@ -34,7 +34,7 @@ extra_css:

copyright: "1999-2020 RingCentral, Inc. All rights reserved."

google_analytics: ['UA-57519112-1', 'developers.ringcentral.com']
#google_analytics: ['UA-57519112-1', 'developers.ringcentral.com']

pages:

Expand Down

0 comments on commit bb49bd5

Please sign in to comment.