ThreadFlow

Appearance

Basic Pages Usage ​

How to create a basic page and define its behavior.

Show ​

The show method describes the logic for sending the initial message to the user when the page is opened.

php
use SequentSoft\ThreadFlow\Messages\Outgoing\Regular\TextOutgoingMessage;

// ...

public function show(): TextOutgoingMessage
{
    return TextOutgoingMessage::make(
        'Hello! What\'s Homer Simpson\'s favorite food?'
    );
}

Answer ​

The answer method describes the logic for processing the user's response to the initial message.

Reply with a text message ​

php
public function answer(IncomingMessageInterface $message): TextOutgoingMessage
{
    if ($message->isText('Donuts')) {
        return TextOutgoingMessage::make('Right! Mmm, donuts.');
    }
    
    if ($message->isText('Duff')) {
        return TextOutgoingMessage::make([
            'Close! Duff is his favorite beer,',
            'but donuts take the cake... or the donut.'
        ]);
    }
    
    return TextOutgoingMessage::make('Nope, it\'s donuts. D\'oh!');
}

Note

Also you can specify the message type as a type hint in the answer method. If the message type does not match, the show method will be called instead.

php
public function show(): TextOutgoingMessage
{
    return TextOutgoingMessage::make(
        'Please send me your contact information.'
    );
}

public function answer(ContactIncomingMessageInterface $message): TextOutgoingMessage
{
    // answer method will be called only if the incoming message is a contact message
    // otherwise, the show method will be called
}

Go to another page ​

php
public function answer(IncomingMessageInterface $message): mixed
{
    if ($message->isText('Donuts')) {
        // Output the message before moving to another page
        TextOutgoingMessage::make('Right! Mmm, donuts.')->reply();
        
        // Go to another page
        return new LoginPage(); 
    }
    
    return TextOutgoingMessage::make('You can\'t login, sorry.');
}

Welcome ​

Some drivers support sending a welcome message when the user opens the chat for the first time.

If welcome method is defined, it will be called when the user opens the chat for the first time. Otherwise, the show method will be called.

php
public function welcome(): TextOutgoingMessage
{
    return TextOutgoingMessage::make('Welcome! You can ask me anything.');
}

Dependency Injection ​

You can inject dependencies into the methods of the page. Laravel's service container will automatically resolve the dependencies.

php
use App\Services\ChuckNorrisJokesService;

class IndexPage extends Page
{
    public function show(ChuckNorrisJokesService $jokesService): void
    {
        return TextOutgoingMessage::make(
            $jokesService->getRandomJoke()
        );
    }
}

Show page to any bot user ​

Sometimes you need to redirect the user to specific page outside the conversation flow. For example, you may want to show a page to the user when something happens in your application.

You can show a page to any bot user using the showPage method.

php
ThreadFlowBot::channel('telegram')
    ->forParticipant('telegram-user-id-1')
    ->showPage(
        new ChatWithAdminPage(myMessageText: 'Hello!')
    );

Note

You can use the forParticipant method to send a message to a specific user or the forRoom method to show a page to a specific room.