eu.vendeli.tgbot.api.botactions.GetMe.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of telegram-bot Show documentation

Telegram Bot API wrapper, with handy Kotlin DSL.

There is a newer version: 6.6.0

@file:Suppress("MatchingDeclarationName")

package eu.vendeli.tgbot.api.botactions

import eu.vendeli.tgbot.interfaces.ActionState
import eu.vendeli.tgbot.interfaces.SimpleAction
import eu.vendeli.tgbot.interfaces.TgAction
import eu.vendeli.tgbot.types.User
import eu.vendeli.tgbot.types.internal.TgMethod
import eu.vendeli.tgbot.utils.getReturnType

/**
 * A simple method for testing your bot's authentication token.
 * Requires no parameters. Returns basic information about the bot in form of a [User](User) object.
 *
 */
class GetMeAction : SimpleAction, ActionState() {
    override val TgAction.method: TgMethod
        get() = TgMethod("getMe")
    override val TgAction.returnType: Class
        get() = getReturnType()
}

/**
 * A simple method for testing your bot's authentication token. Requires no parameters.
 * Returns basic information about the bot in form of a [User](User) object.
 *
 */
fun getMe() = GetMeAction()