IBM Verse: Extension Points - Examples: Difference between revisions
| Line 5: | Line 5: | ||
* Mail Read View | * Mail Read View | ||
Here is the full list of extension points that Verse supports | |||
= Links = | |||
Example: | Example: | ||
| Line 11: | Line 13: | ||
[[file:VerseApplicationLinks.png]] | [[file:VerseApplicationLinks.png]] | ||
==Simple Link (com.ibm.appreg.ext.simpleLink) == | ==Simple Link (object: com.ibm.appreg.ext.simpleLink) == | ||
A Simple Link extension adds a clickable URL link to the Verse UI. | A Simple Link extension adds a clickable URL link to the Verse UI. | ||
| Line 19: | Line 21: | ||
[[File:Verse-simple-link.png]] | [[File:Verse-simple-link.png]] | ||
==Templated Link (com.ibm.appreg.ext.templatedLink)== | ==Templated Link (object: com.ibm.appreg.ext.templatedLink)== | ||
'''Object: com.ibm.appreg.ext.templatedLink''' | |||
A Templated Link extension adds a clickable URL link to the Verse UI including the option to configure the extension to receive data from Verse encoded in the URL. | A Templated Link extension adds a clickable URL link to the Verse UI including the option to configure the extension to receive data from Verse encoded in the URL. | ||
| Line 34: | Line 38: | ||
=== Action for Business Card === | === Action for Business Card (object: com.ibm.appreg.object.person)=== | ||
The extension declares one action which is bound to the com.ibm.appreg.object.person object, which means it displays on the back of all Verse business cards. | The extension declares one action which is bound to the '''com.ibm.appreg.object.person''' object, which means it displays on the back of all Verse business cards. | ||
When this action is triggered it will open the associated web application in a new window. On image VerseApplicationLinks.png, item '''2'''. . When clicked open a new window. | When this action is triggered it will open the associated web application in a new window. On image VerseApplicationLinks.png, item '''2'''. . When clicked open a new window. | ||
| Line 44: | Line 46: | ||
[[File:verse-widget-person-link.png]] | [[File:verse-widget-person-link.png]] | ||
=== Action for Mail Compose === | === Action for Mail Compose ('''path: mail.compose''')=== | ||
This action which appear in the toolbar displayed when composing a mail i.e. Mail Compose view. Useful to display information relevant to a mail when user is currently composing. | This action which appear in the toolbar displayed when composing a mail i.e. Mail Compose view. Useful to display information relevant to a mail when user is currently composing. | ||
Example of use: | Example of use: | ||
| Line 55: | Line 57: | ||
=== Action for Mail Read === | === Action for Mail Read ('''path: mail.read''')=== | ||
This action which will display when the user is reading a mail i.e. the Mail Read view. Useful when you want to transfer received mails from Verse to another application. | This action which will display when the user is reading a mail i.e. the Mail Read view. Useful when you want to transfer received mails from Verse to another application. | ||
Example of use: | Example of use: | ||
| Line 76: | Line 76: | ||
:* See this code on [https://github.com/markewallace/verse-watsonwork GitHub - verse-watsonwork] | :* See this code on [https://github.com/markewallace/verse-watsonwork GitHub - verse-watsonwork] | ||
==com.ibm.verse.ext.namePicker== | ==com.ibm.verse.ext.namePicker ("type": "com.ibm.verse.ext.namePicker",)== | ||
Extension that add a custom name picker in mail compose view | |||
* [https://ibmverse.github.io/verse-developer/tutorials/#add-custom-name-picker-extension Custom Name Picker] | * Tutorial [https://ibmverse.github.io/verse-developer/tutorials/#add-custom-name-picker-extension Custom Name Picker] | ||
Revision as of 19:04, 7 February 2018
Currently on Verse 1.0.3, Verse has the following options:
- Business Card
- Mail Compose View
- Mail Read View
Here is the full list of extension points that Verse supports
Links
Example:
Simple Link (object: com.ibm.appreg.ext.simpleLink)
A Simple Link extension adds a clickable URL link to the Verse UI.
On image VerseApplicationLinks.png, item 0. When clicked open a new window.
Templated Link (object: com.ibm.appreg.ext.templatedLink)
Object: com.ibm.appreg.ext.templatedLink
A Templated Link extension adds a clickable URL link to the Verse UI including the option to configure the extension to receive data from Verse encoded in the URL.
On image VerseApplicationLinks.png, item 1. . When clicked open a new window.
Widget (com.ibm.verse.ext.widget)
A Widget extension associates a third party web application with Verse by opening a new browser window/tab or embedding the application using an iframe within the Verse UI. A widget extension may contribute multiple Widget Actions to the Verse UI.
All of actions in the widget will share the same url. When Widget Action is clicked, the application opened by the widget’s url will be rendered on the different place based on the action’s location.
Action for Business Card (object: com.ibm.appreg.object.person)
The extension declares one action which is bound to the com.ibm.appreg.object.person object, which means it displays on the back of all Verse business cards.
When this action is triggered it will open the associated web application in a new window. On image VerseApplicationLinks.png, item 2. . When clicked open a new window.
Action for Mail Compose (path: mail.compose)
This action which appear in the toolbar displayed when composing a mail i.e. Mail Compose view. Useful to display information relevant to a mail when user is currently composing.
Example of use:
- use Watson Tone Analyzer to provide the user with data on the tone of the mail before they send it.
Action for Mail Read (path: mail.read)
This action which will display when the user is reading a mail i.e. the Mail Read view. Useful when you want to transfer received mails from Verse to another application.
Example of use:
- Update CRM System, like Salesforce
- Integrating IBM Verse with Salesforce and Lightning Out or on see code on GitHub
- Use Watson Tone Analyzer to provide the user with data on the tone of the mail.
- See code on Verse Tone Analyzer
- use Watson Text To Speech to listen email
- See code on Verse Read Mail
- Update Watson Workspace
- See this video IBM Watson Workspace - Verse To Workspace Demo
- See this code on GitHub - verse-watsonwork
com.ibm.verse.ext.namePicker ("type": "com.ibm.verse.ext.namePicker",)
Extension that add a custom name picker in mail compose view
- Tutorial Custom Name Picker