You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/06/01 09:10:21 UTC
[07/14] camel git commit: Added some documentation
Added some documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/7930c7a9
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/7930c7a9
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/7930c7a9
Branch: refs/heads/master
Commit: 7930c7a93e2990ed00a9f99e8eb01d72dc5388fd
Parents: dc8e761
Author: Mike Kennedy <mi...@ucr.edu>
Authored: Sat May 30 23:51:22 2015 -0700
Committer: Claus Ibsen <da...@apache.org>
Committed: Mon Jun 1 08:55:13 2015 +0200
----------------------------------------------------------------------
components/camel-slack/README.md | 60 +++++++++++++++++++++++++++++++++++
1 file changed, 60 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/7930c7a9/components/camel-slack/README.md
----------------------------------------------------------------------
diff --git a/components/camel-slack/README.md b/components/camel-slack/README.md
new file mode 100644
index 0000000..09b5dab
--- /dev/null
+++ b/components/camel-slack/README.md
@@ -0,0 +1,60 @@
+Camel Slack Component
+=====================
+
+The **slack** component allows you to connect to an instance of [Slack](http://www.slack.com) and delivers a message contained in the message body via a pre established [Slack incoming webhook](https://api.slack.com/incoming-webhooks).
+
+## URI format
+
+To send a message to a channel.
+
+```
+slack:#channel[?options]
+```
+
+To send a direct message to a slackuser.
+
+```
+slack:@username[?options]
+```
+
+The Slack component only supports producer endpoints so you cannot use this component at the beginning of a route to listen to messages in a channel.
+
+## Options
+
+These options will
+
+| Option | Example | Description |
+| ------ | ------- | ----------- |
+| `username` | `username=CamelUser` | This is the username that the bot will have when sending messages to a channel or user. |
+| `iconUrl` | `iconUrl=http://somehost.com/avatar.gif` | The avatar that the component will use when sending message to a channel or user. |
+| `iconEmoji` | `iconEmoji=:camel:` | Use a Slack emoji as an avatar |
+
+## SlackComponent
+
+The SlackComponent must be configured as a Spring or Blueprint bean that contains the incoming webhook url for the integration as a parameter.
+
+```
+<bean id="slack" class="io.mikekennedy.camel.SlackComponent">
+ <property name="webhookUrl" value="https://hooks.slack.com/services/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"/>
+</bean>
+```
+
+## Example Configuration
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" default-activation="lazy">
+
+ <bean id="slack" class="io.mikekennedy.camel.SlackComponent">
+ <property name="webhookUrl" value="https://hooks.slack.com/services/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"/>
+ </bean>
+
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
+ <route>
+ <from uri="direct:test"/>
+ <to uri="slack:#channel?iconEmoji=:camel:&username=CamelTest"/>
+ </route>
+ </camelContext>
+
+</blueprint>
+```
\ No newline at end of file