Twitter Direct Message

Send and receive Twitter direct messages.

Metadata

Property	Value
Scheme	`twitter-directmessage`
Support Level	Stable
Labels	saas,social
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-twitter</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`user`	string	✓		The user name to send a direct message. This will be ignored for consumer.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`type`	object		`polling`	Endpoint type to use.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`distanceMetric`	string		`km`	Used by the geography search, to search by radius using the configured metrics. The unit can either be mi for miles, or km for kilometers. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`extendedMode`	boolean		`true`	Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters).
`latitude`	number			Used by the geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.
`locations`	string			Bounding boxes, created by pairs of lat/lons. Can be used for filter. A pair is defined as lat,lon. And multiple pairs can be separated by semicolon.
`longitude`	number			Used by the geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`radius`	number			Used by the geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`count`	integer		`5`	Limiting number of results per page.
`filterOld`	boolean		`true`	Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id.
`lang`	string			The lang string ISO_639-1 which will be used for searching
`numberOfPages`	integer		`1`	The number of pages result which you want camel-twitter to consume.
`sinceId`	integer		`1`	The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running.
`userIds`	string			To filter by user ids for filter. Multiple values can be separated by comma.
`httpProxyHost`	string			The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
`httpProxyPassword`	string			The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
`httpProxyPort`	integer			The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
`httpProxyUser`	string			The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	duration		`30000`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`accessToken`	string			The access token. Can also be configured on the TwitterComponent level instead.
`accessTokenSecret`	string			The access secret. Can also be configured on the TwitterComponent level instead.
`consumerKey`	string			The consumer key. Can also be configured on the TwitterComponent level instead.
`consumerSecret`	string			The consumer secret. Can also be configured on the TwitterComponent level instead.
`sortById`	boolean		`true`	Sorts by id, so the oldest are first, and newest last.