Actions

Your add-on can contribute specialized actions in multiple locations in HipChat. These actions can be used by users to act on messages or objects which are surfaced in Sidebar Views.


 

Input actions

Input actions are triggered from the input field using the "" icon. 

This action should only be used to add content directly into chat. 

Card and message actions

Actions are triggered from the "" icon.

Card actions

Cards can support multiple actions - click to expand or collapse.

Message actions

Action buttons are used to provide actions like discuss, open in browser or open in application in the main chat view.

View actions

Actions are triggered from the "" icon from within the full view.

Using actions

Declaring an action

API Reference

View the API reference for Actions 

Your add-on must declare the action in the add-on descriptor. Actions can open sidebar views, dialogs or external pages.

For example to add a message action which opens a custom Dialog View:

"capabilities": {
	...,
	"action": [
  		{
    		"key": "message.reminder",
    		"name": {
      			"value": "Set Reminder"
    		},
    		"target": "dialog-key",               --> This can be the key of a web panel, dialog or external page
    		"location": "hipchat.message.action"  --> or hipchat.input.action
  		}
	]
}

Action target

The target of an action can be:

  • Opening a Dialog
  • Opening a Sidebar
  • Opening an External Page (open a new browser tab, load a URL, passing context parameters)

Processing an Action

If the target of an action is a Dialog or Sidebar you can register a listener for this action in the target view (dialog or sidebar) using the Javascript API. If the action is a message action, you can also retrieve the message content:

AP.register({
  "message.reminder": function (message) {  --> (the registration uses the key from the action descriptor entry)
    handle(message);
  }
});

Action conditions

Message actions can be context sensitive. For example, you can choose to show actions only if a message contains a link or a certain pattern:

"capabilities": {
	...,
	"action": [
  		{
    		"key": "message.reminder",
    		"name": {
      			"value": "Set Reminder"
    		},
    		"target": "dialog-key",
    		"location": "hipchat.message.action",
    		"conditions": [
      			{
        			"condition": "message_contains_link"
      			}
    		]
  		}
	]
}

Action conditions for cards

A common use case is exposing actions on cards. These actions may vary with the card contents, and card metadata in combination with conditions can be used for this.

Example Card
{
  "style": "image",
  "id": "29c45d11-f0ea-45da-8500-1cd233f78da0",
  "url": "https://example.com",
  "title": "A title",
  "description": "A card",
  ...
  "metadata": {
    "status": "open"
  }
} 
Condition Description
{
  "condition": "card_matches",
  "params": {
    "style": "image"
   }
}
Contribute an action for cards of a particular style.
{
  'condition': 'card_matches',
  'params': {
    'metadata': [
      { 'attr': 'status', 'eq': 'open'}
    ]
  }
}

Contribute an action for cards that are enabled only if a metadata condition matches.

Object structures are supported:

"metadata": {
  "indicent": {
    "status": "open"
  }
}

can be checked in the condition using:

'metadata': [
  { 'attr': 'indicent.status', 'eq': 'open'}
]

Supported operators:

  • Equality: 'eq'
  • Less than (numeric values): 'lt'
  • Greater than (numeric values): 'gt'

 

Other supported conditions

Condition Description
{
  "condition": "room_is_public"
}
Is true for public rooms.
 {
  "condition": "user_is_admin"
}
Is true if the logged-in user is an administrator.
{
  "condition": "user_is_guest"
} 
Is true if the logged-in user is a guest user.
 {
  "condition": "user_is_room_owner"
}
Is true if the logged-in user is the room owner.
 {
  "condition": "message_matches",
  "params": {
    "type": "notification"
  }
}
True if the message type matches. Possible types are:
  • message
  • notification
 {
  "condition": "message_matches",
  "params": {
    "regex": {
      "pattern": "\(yey\)",
      "flags": "i"
    }
  }
}
True if the message body matches the regular expression.
 {
  "condition": "message_matches",
  "params": {
    "sender": "My Add-on"
  }
}
True if the message sender matches the provided string.
{
  "condition": "message_contains_link"
}
True if the message contains a link.
 {
  "condition": "message_sent_by_current_user"
}
True if the message was sent by the logged-in user.

 

You can negate a condition by using the "invert" attribute on a condition:

{
  "condition": "user_is_admin",
  "invert": true
}

 

 

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport