com.github.kshashov.telegram.api.bind.annotation

Annotation Type BotRequest

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface BotRequest

Annotation for mapping telegram requests onto methods in request-handling classes with flexible method signatures. In most cases, it is preferred to use one of the telegram method specific variants MessageRequest, EditedMessageRequest, ChannelPostRequest, EditedChannelPostRequest, InlineQueryRequest, CallbackQueryRequest, ChosenInlineResultRequest, ShippingQueryRequest, PollRequest, PreCheckoutQueryRequest.

Note: works only with methods in the class marked with BotController annotation

.

Note: if the telegram request matched with several patterns at once, the result pattern will be selected randomly

.

See Also:

BotController, MessageRequest, EditedMessageRequest, ChannelPostRequest, EditedChannelPostRequest, InlineQueryRequest, CallbackQueryRequest, ChosenInlineResultRequest, ShippingQueryRequest, PreCheckoutQueryRequest, PollRequest

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	path
MessageType[]	type
String[]	value The primary mapping expressed by this annotation.

Element Detail

value

@AliasFor(value="path")
public abstract String[] value

The primary mapping expressed by this annotation.

This is an alias for path(). For example @BotRequest("/foo") is equivalent to @BotRequest(path="/foo").

Returns:

Request mapping templates.

Default:

{}

path

@AliasFor(value="value")
public abstract String[] path

Returns:

Request mapping templates (e.g. "/foo"). Ant-style path patterns are also supported (e.g. "/foo *", "/foo {param:[0-9]}"). An empty patterns list (= any request) has the lowest priority and will be matched only if there is no match in the other methods. See DefaultRequestMappingsMatcherStrategy default comparator for route priority details.

See Also:

AntPathMatcher

Default:

{}

type

public abstract MessageType[] type

Returns:

Telegram request types to map.

Default:

com.github.kshashov.telegram.api.MessageType.ANY