org.mule.module

mule-module-kindling

config

Namespace	http://www.mulesoft.org/schema/mule/kindling
Schema Location	http://www.mulesoft.org/schema/mule/kindling/current/mule-kindling.xsd (View Schema)
Schema Version	2.2
Minimum Mule Version	3.2

Module Overview

Kindling Cloud Connector

Kindling ignites innovation by connecting people and ideas

Allows to connect to the kindling site across the Kindling Service API. Connector created with the documentation of the service for the version v3.12.0.2

Summary

Configuration
<kindling:config> Configure an instance of this module

Message Processors
<kindling:create-category> Creates a new category in the categories collection
<kindling:create-comment> Creates a new comment in the comments collection
<kindling:create-group> Create a new group in the groups collection
<kindling:create-idea> Create a new idea in the ideas collection
<kindling:create-post> Creates a new post
<kindling:create-user> Creates a new user in the users collection
<kindling:delete-comment> Deletes a single comment
<kindling:delete-user> Deletes a single user
<kindling:retrieve-categories> Gets the categories collection
<kindling:retrieve-category> Gets a single category
<kindling:retrieve-comment> Gets a single comment
<kindling:retrieve-comments> Gets the comments collection
<kindling:retrieve-group> Gets a single group
<kindling:retrieve-groups> Gets the groups collection
<kindling:retrieve-idea> Gets a single idea
<kindling:retrieve-ideas> Gets the ideas collection
<kindling:retrieve-post> Gets a single post
<kindling:retrieve-posts> Gets the posts collection
<kindling:retrieve-user> Gets a single user
<kindling:retrieve-users> Gets the users collection
<kindling:update-category> Updates a single category
<kindling:update-group> Updates a single group
<kindling:update-idea> Updates a single idea
<kindling:update-post> Updates a single post
<kindling:update-user> Updates a single user

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:kindling="http://www.mulesoft.org/schema/mule/kindling"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/kindling
               http://www.mulesoft.org/schema/mule/kindling/current/mule-kindling.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <kindling:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		A username	String	/	UTF-8
password		A password	String	/	UTF-8
companyName		The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <kindling:config>
         <reconnect count="5" frequency="1000"/>
    </kindling:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<kindling:create-category>

Creates a new category in the categories collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
category	The `KindlingCategory` to be created	KindlingCategory	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCategory	A `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:create-comment>

Creates a new comment in the comments collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
comment	The `KindlingComment` to be created	KindlingComment	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingComment	A `KindlingComment`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:create-group>

Create a new group in the groups collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
group	The `KindlingGroup` to be created	KindlingGroup	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingGroup	A `KindlingGroup`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:create-idea>

Create a new idea in the ideas collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
idea	The `KindlingIdea` to be created	KindlingIdea	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingIdea	idea.json

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:create-post>

Creates a new post

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
post	The `KindlingCategory` to be created	KindlingPost	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingPost	A `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:create-user>

Creates a new user in the users collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	The `KindlingUser` to be created	KindlingUser	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingUser	A `KindlingUser`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:delete-comment>

Deletes a single comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	The id of the comment to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:delete-user>

Deletes a single user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userId	The id of the user to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-categories>

Gets the categories collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20. The limit on number of collection items to show per page	Integer	/
state	Optional. Default: ACTIVATED. Get only items in the collection that are in the given state, either by a state ID or it's natural language name	KindlingCategoryState	/
query	Optional. A general category search	String	/	UTF-8
associatedWithUserId	Optional. If provided, will only return categories that the given user ID has access to	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingCategory>	A `KindlingCollection` of `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-category>

Gets a single category

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The id of the category to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCategory	A `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-comment>

Gets a single comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	The id of the comment to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-comments>

Gets the comments collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
parentType	Retrieve only comments whose parent is of this type	KindlingCommentParentType	/
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20 The limit on number of collection items to show per page	Integer	/
state	Optional. Default: ACTIVATED. Get only items in the collection that are in the given state, either by a state ID or it's natural language name	KindlingState	/
parentId	Optional. Retrieve only comments of a specific parent ID	Integer	/
type	Optional. The type of comments to retrieve	KindlingCommentType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingComment>	A `KindlingCollection` of `KindlingComment`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-group>

Gets a single group

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupId	The id of the group to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc. group.json	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingGroup	A `KindlingGroup`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-groups>

Gets the groups collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20 The limit on number of collection items to show per page	Integer	/
state	Optional. Default: ACTIVATED. Get only items in the collection that are in the given state, either by a state ID or it's natural language name	KindlingState	/
startsWith	Optional. Find group titles beginning with this string	String	/	UTF-8
query	Optional. A general group search	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingGroup>	A `KindlingCollection` of `KindlingGroup`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-idea>

Gets a single idea

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
ideaId	The id of the Idea to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingIdea	A `KindlingIdea`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-ideas>

Gets the ideas collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20 The limit on number of collection items to show per page	Integer	/
state	Optional. Get only items in the collection that are in the given state, either by a state ID or it's natural language name drafted open approved completed declined paused others depending on workflow settings	String	/	UTF-8
allowsVoting	Optional. Only show ideas that can or cannot be voted upon	Boolean	/
query	Optional. A general idea search string	String	/	UTF-8
authorId	Optional. Show only ideas from a particular author	String	/	UTF-8
categoryId	Optional. Show only ideas in a particular category	String	/	UTF-8
filter	Optional. Conceptual filters	KindlingIdeaFilter	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingIdea>	A `KindlingCollection` of `KindlingIdea`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-post>

Gets a single post

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
postId	The id of the post to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingPost	A `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-posts>

Gets the posts collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20. The limit on number of collection items to show per page	Integer	/
state	Optional. Default: ACTIVATED. Get only items in the collection that are in the given state, either by a state ID or it's natural language name	KindlingPostState	/
startsWith	Optional. Find posts beginning with this string	String	/	UTF-8
query	Optional. A general post search	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingPost>	A `KindlingCollection` of `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-user>

Gets a single user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userId	The id of the user to retrieve	String	/	UTF-8
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingUser	A `KindlingUser`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:retrieve-users>

Gets the users collection

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
depth	Optional. Default: 0. Any object in the result can be displayed at depth, 0 = no depth, 1 = expand first relational object level, etc.	Integer	/
sort	Optional. Default: title. How the collection output will be sorted, like 'date ASC', 'date', or 'name DESC' etc.	String	/	UTF-8
page	Optional. Default: 1. The page requested	Integer	/
limit	Optional. Default: 20. The limit on number of collection items to show per page	Integer	/
state	Optional. Default: ACTIVATED. Get only items in the collection that are in the given state, either by a state ID or it's natural language name	KindlingUserState	/
associatedWithCategoryId	Optional. Only show users associated with a particular category	Integer	/
digest	Optional. Show only users with a particular type of digest set	KindlingUserDigest	/
query	Optional. General user search string	String	/	UTF-8
reputationTimeframe	Optional. If present, will turn this request into one specifically for reputation leaders for a given timeframe, which may be combined with the associatedWithCategoryId parameter as well to return a leaderbooard for a category	KindlingUserReputationTimeframe	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCollection<KindlingUser>	A `KindlingCollection` of `KindlingUser`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:update-category>

Updates a single category

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The id of the category to update	String	/	UTF-8
category	The `KindlingCategory` with the data to be updated	KindlingCategory	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingCategory	A `KindlingCategory`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:update-group>

Updates a single group

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupId	The id of the group to retrieve	String	/	UTF-8
group	The `KindlingGroup` with the data to be updated	KindlingGroup	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingGroup	A `KindlingGroup`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:update-idea>

Updates a single idea

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
ideaId	The id of the Idea to update	String	/	UTF-8
idea	The `KindlingIdea` with the data to be updated	KindlingIdea	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingIdea	A `KindlingIdea`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:update-post>

Updates a single post

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
postId	The id of the post to update	String	/	UTF-8
post	The `KindlingPost` with the data to be updated	KindlingPost	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingPost	A `KindlingPost`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw

<kindling:update-user>

Updates a single user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userId	The id of the user to update	String	/	UTF-8
user	The `KindlingUser` with the data to be updated	KindlingUser	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8
companyName	Optional. The name of the company registered in kindling and used for access your site like https://{companyName}.kindlingapp.com	String	/	UTF-8

Returns

Return Type	Description
KindlingUser	A `KindlingUser`

Exception Payloads

Payload Class	Description
KindlingConnectorException	If something goes wrong with the service API this exception is throw
KindlingConnectorUnauthorizedException	If the credentials provided for the user are wrong or are expired this exception is throw