UIAction (MessageML Utils 0.10.2 API)

java.lang.Object
- org.symphonyoss.symphony.messageml.elements.Element
- - org.symphonyoss.symphony.messageml.elements.UIAction

```
public class UIAction
extends Element
```
This class specify the Symphony Component UIAction which is represented by the tag name "ui-action". The messageML representation of this element can contain the following fields:
- trigger -> default 'click', trigger of the action. For now only 'click' is supported
- action (required) -> action that can be executed on trigger. For now only 'open-im' is supported
The open-im action can support the following attributes:
- user-ids (exclusive with stream-id)-> list of the users we want the action to be applied on
- stream-id (exclusive with user-ids) -> stream we want the action to be applied on
- side-by-side -> default true, open the result chat in a new module and keeps the parent one open side by side. If false, the parent one will be replaced.

Field Summary

Fields
Modifier and Type Field Description

static String MESSAGEML_TAG

static String PRESENTATIONML_CLASS

static String TARGET_ID
- Fields inherited from class org.symphonyoss.symphony.messageml.elements.Element
  CLASS_ATTR, format, ID_ATTR, ID_MAX_LENGTH, MAPPER, STYLE_ATTR

Constructor Summary

Constructors
Constructor Description

UIAction(Element parent, FormatEnum format)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`buildAttribute(MessageMLParser parser, Node item)`
`String`	`getPresentationMLTag()`	Return the element's PresentationML tag.
`void`	`validate()`

Methods inherited from class org.symphonyoss.symphony.messageml.elements.Element
addChild, areNestedElementsAllowed, asText, buildAll, buildNode, checkIntegerAttribute, countChildrenOfType, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, putIntegerIfPresent, putOneIfPresent, putStringIfPresent, size, throwInvalidInputException

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- MESSAGEML_TAG
```
public static final String MESSAGEML_TAG
```
  See Also:
  
  Constant Field Values
- TARGET_ID
```
public static final String TARGET_ID
```
  See Also:
  
  Constant Field Values
- PRESENTATIONML_CLASS
```
public static final String PRESENTATIONML_CLASS
```
  See Also:
  
  Constant Field Values

Constructor Detail

UIAction

public UIAction(Element parent,
                FormatEnum format)

Method Detail

buildAttribute

protected void buildAttribute(MessageMLParser parser,
                              Node item)
                       throws InvalidInputException

Throws:: InvalidInputException

validate

public void validate()
              throws InvalidInputException

Throws:: InvalidInputException

getPresentationMLTag
```
public String getPresentationMLTag()
```
Description copied from class: Element

Return the element's PresentationML tag. By default is equals to MessageML tag, override when needed

Overrides:

getPresentationMLTag in class Element