You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/06/30 12:09:10 UTC

camel git commit: Added camel-cm-sms docs to Gitbook

Repository: camel
Updated Branches:
  refs/heads/master 18198a38d -> 4729fb5fa


Added camel-cm-sms docs to Gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4729fb5f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4729fb5f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4729fb5f

Branch: refs/heads/master
Commit: 4729fb5faf98396cf6f39b1ea32a4f1808eff3e6
Parents: 18198a3
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 30 14:08:11 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 30 14:08:11 2016 +0200

----------------------------------------------------------------------
 .../camel-cm-sms/src/main/docs/cm-sms.adoc      | 66 ++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |  1 +
 2 files changed, 67 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/4729fb5f/components/camel-cm-sms/src/main/docs/cm-sms.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cm-sms/src/main/docs/cm-sms.adoc b/components/camel-cm-sms/src/main/docs/cm-sms.adoc
new file mode 100644
index 0000000..e8afb4d
--- /dev/null
+++ b/components/camel-cm-sms/src/main/docs/cm-sms.adoc
@@ -0,0 +1,66 @@
+[[CM-SMS]]
+CM-SMS
+~~~~~~
+
+*Available as of Camel 2.18*
+
+*Camel-Cm-Sms* is an http://camel.apache.org/[Apache Camel] component 
+for the [CM SMS Gateway](https://www.cmtelecom.com). 
+
+It allows to integrate https://dashboard.onlinesmsgateway.com/docs[CM SMS API]in an application as a camel component. 
+
+You must have a valid account.  More information are available at https://www.cmtelecom.com/support[CM Telecom].
+
+[source,java]
+-------------------------------
+cm-sms://sgw01.cm.nl/gateway.ashx?defaultFrom=DefaultSender&defaultMaxNumberOfParts=8&productToken=xxxxx
+-------------------------------
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+[source,xml]
+---------------------------------------------------------
+<dependency>
+�<groupId>org.apache.camel</groupId>
+�<artifactId>camel-cm-sms</artifactId>
+�<version>x.x.x</version>
+�<!-- use the same version as your Camel core version -->
+</dependency>
+---------------------------------------------------------
+
+[[CM-SMS-Options]]
+Options
+~~~~~~~
+
+
+// component options: START
+The CM SMS Gateway component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The CM SMS Gateway component supports 7 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | producer |  | String | *Required* SMS Provider HOST with scheme
+| defaultFrom | producer |  | String | This is the sender name. The maximum length is 11 characters.
+| defaultMaxNumberOfParts | producer | 8 | int | If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters if so the message will be cut into multiple 153 characters parts limited by these parameters.
+| productToken | producer |  | String | *Required* The unique token to use
+| testConnectionOnStartup | producer | false | boolean | Whether to test the connection to the SMS Gateway on startup
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[CM-SMS-Sample]]
+Sample
+~~~~~~
+
+You can try https://github.com/oalles/camel-cm-sample[this project] to see how camel-cm-sms can be integrated in a camel route. 

http://git-wip-us.apache.org/repos/asf/camel/blob/4729fb5f/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 005396c..0d202aa 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -137,6 +137,7 @@
     * [CDI](cdi.adoc)
     * [Chunk](chunk.adoc)
     * [Cmis](cmis.adoc)
+    * [CM SMS](cm-sms.adoc)
     * [CoAP](coap.adoc)
     * [Cometd](cometd.adoc)
     * [Context](context.adoc)