org.apache.camel.builder.endpoint.dsl

Interface TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

TelegramEndpointBuilderFactory.TelegramEndpointBuilder

Enclosing interface:

TelegramEndpointBuilderFactory

public static interface TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Telegram component.

Method Summary

Modifier and Type	Method and Description
default TelegramEndpointBuilderFactory.AdvancedTelegramEndpointProducerBuilder	advanced()
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	authorizationToken(String authorizationToken) The authorization token for using the bot (ask the BotFather).
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	chatId(String chatId) The identifier of the chat that will receive the produced messages.
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	proxyHost(String proxyHost) HTTP proxy host which could be used when sending out the message.
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	proxyPort(Integer proxyPort) HTTP proxy port which could be used when sending out the message.
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	proxyPort(String proxyPort) HTTP proxy port which could be used when sending out the message.
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	proxyType(String proxyType) HTTP proxy type which could be used when sending out the message.
default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder	proxyType(TelegramEndpointBuilderFactory.TelegramProxyType proxyType) HTTP proxy type which could be used when sending out the message.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default TelegramEndpointBuilderFactory.AdvancedTelegramEndpointProducerBuilder advanced()

chatId

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder chatId(String chatId)

The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot, its client sends automatically a '/start' message containing the chat id). It is an optional parameter, as the chat id can be set dynamically for each outgoing message (using body or headers). The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

chatId - the value to set

Returns:

the dsl builder

lazyStartProducer

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

proxyHost

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder proxyHost(String proxyHost)

HTTP proxy host which could be used when sending out the message. The option is a: <code>java.lang.String</code> type. Group: proxy

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder proxyPort(Integer proxyPort)

HTTP proxy port which could be used when sending out the message. The option is a: <code>java.lang.Integer</code> type. Group: proxy

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder proxyPort(String proxyPort)

HTTP proxy port which could be used when sending out the message. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyType

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder proxyType(TelegramEndpointBuilderFactory.TelegramProxyType proxyType)

HTTP proxy type which could be used when sending out the message. The option is a: <code>org.apache.camel.component.telegram.TelegramProxyType</code> type. Default: HTTP Group: proxy

Parameters:

proxyType - the value to set

Returns:

the dsl builder

proxyType

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder proxyType(String proxyType)

HTTP proxy type which could be used when sending out the message. The option will be converted to a <code>org.apache.camel.component.telegram.TelegramProxyType</code> type. Default: HTTP Group: proxy

Parameters:

proxyType - the value to set

Returns:

the dsl builder

authorizationToken

default TelegramEndpointBuilderFactory.TelegramEndpointProducerBuilder authorizationToken(String authorizationToken)

The authorization token for using the bot (ask the BotFather). The option is a: <code>java.lang.String</code> type. Required: true Group: security

Parameters:

authorizationToken - the value to set

Returns:

the dsl builder