TgBotApi\BotApiBase\Method\AnswerInlineQueryMethod

Complexity

Total Complexity

3

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	10	2
A	addResult()	0	5	1

<?php

declare(strict_types=1);

namespace TgBotApi\BotApiBase\Method;

use TgBotApi\BotApiBase\Method\Traits\FillFromArrayTrait;
use TgBotApi\BotApiBase\Type\InlineQueryResult\InlineQueryResultType;

/**
 * Class AnswerInlineQueryMethod.
 *
 * Use this method to send answers to an inline query. On success, True is returned.
 * No more than 50 results per query are allowed.
 *
 * @see https://core.telegram.org/bots/api#answerinlinequery
 */
class AnswerInlineQueryMethod
{
    use FillFromArrayTrait;

    /**
     * Unique identifier for the answered query.
     *
     * @var string
     */
    public $inlineQueryId;

    /**
     * A JSON-serialized array of results for the inline query.
     *
     * @var InlineQueryResultType[]
     */
    public $results;

    /**
     * Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server.
     * Defaults to 300.
     *
     * @var \DateTimeInterface|null
     */
    public $cacheTime;

    /**
     * Optional. Pass True, if results may be cached on the server side only for the user that sent the query.
     * By default, results may be returned to any user who sends the same query.
     *
     * @var bool|null
     */
    public $isPersonal;

    /**
     * Optional. Pass the offset that a client should send in the next query with the same text to receive more results.
     * Pass an empty string if there are no more results or if you don‘t support pagination.
     * Offset length can’t exceed 64 bytes.
     *
     * @var string|null
     */
    public $nextOffset;

    /**
     * Optional. If passed, clients will display a button with specified text that switches the user to a private
     * chat with the bot and sends the bot a start message with the parameter switch_pm_parameter.
     *
     * @var string|null
     */
    public $switchPmText;

    /**
     * String    Optional. Deep-linking parameter for the /start message sent to the bot when user presses the switch
     * button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.
     *
     * Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account
     * to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’
     * button above the results, or even before showing any. The user presses the button, switches to a private chat
     * with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link.
     * Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where
     * they wanted to use the bot's inline capabilities.
     *
     * @var string|null
     */
    public $switchPmParameter;

    /**
     * @param string                  $inlineQueryId
     * @param InlineQueryResultType[] $results
     * @param array|null              $data
     *
     * @throws \TgBotApi\BotApiBase\Exception\BadArgumentException
     *
     * @return AnswerInlineQueryMethod
     */
    public static function create(string $inlineQueryId, array $results, array $data = null): AnswerInlineQueryMethod
    {
        $instance = new static();
        $instance->inlineQueryId = $inlineQueryId;
        $instance->results = $results;
        if ($data) {
            $instance->fill($data);
        }

        return $instance;
    }

    /**
     * @param InlineQueryResultType $result
     *
     * @return AnswerInlineQueryMethod
     */
    public function addResult(InlineQueryResultType $result): AnswerInlineQueryMethod
    {
        $this->results[] = $result;

        return $this;
    }
}