Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following tags will be accepted by the API Agent and will be transliterated to the given standard tags:

Transitional Tag

MessageML

Equivalent

Standard Tag

PresentationML

Description
<mention

<mention email="user@domain"/>

<mention

<mention uid="

123456789

numericUserId"/>

<a class="mention" href="/userId/numericUserId">@Pretty Name</a>

It is inconvenient for API callers to identify the correct numeric ID for a user when constructing a Mention (although API to find this from an email address does exist). It is also necessary for the pretty name provided in the PresentationML mention markup to be validated. For these reasons additional mention tags will be provided which will be mapped to equivalent PresentationML markup by the API agent.
<chime

<chime/>

<audio src="https://asset.symphony.com/symphony/audio/chime.mp3autoplay/>A shorthand to allow a chime to be sent in a message.
<card iconSrc="url" class="barStyle"><header>PresentationML</header><body>PresentationML</body></card>
A card is a standard item in a message which has a number of visual elements and which can be opened and closed.

Transitional MessageML Elements

The following tags will be accepted by the API Agent for a transitional period and will be transliterated to the given standard tags:

Transitional Tag

Equivalent

Standard Tag

PresentationML

<hash tag="tag"/>

<a class="hashTag">#tag</a>

<cash tag="tag"/>

<a class="cashTag">$tag</a>

Template Macros

The API Agent will support Freemarker templating (see http://freemarker.org/). Any MessageJSON content associated with a message will be made available as the data model in the Freemarker interpreter and macros can then be used to expand the supplied MessageML document into a PresentationML document which fully describes the message.

...