Setup

Before your application can interact with Wirechat, your user model needs to be “Wirechat-aware.” This is done in two parts:

1. Implement the WirechatUser contract This contract tells Wirechat that the model is eligible to participate in chats. It also defines key methods (such as panel authorization) that you may customize.

2. Use the InteractsWithWirechat trait This trait provides ready-made methods for starting conversations, sending messages, and working with groups. You can use it as-is or override specific behaviors to suit your application.

#Model Setup

This shows how to implement the WirechatUser contract and use the InteractsWithWirechat trait in your user model, enabling chat, group creation, and panel access. You can customize permissions by overriding the provided methods to control who can access panels or create chats and groups.

namespace App\Models;

use Wirechat\Wirechat\Panel\Panel;
use Wirechat\Wirechat\Traits\InteractsWithWirechat;
use Wirechat\Wirechat\Contracts\WirechatUser;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements WirechatUser
{
    use InteractsWithWirechat;

    /**
     * Decide if this user may access the given panel.
     * Here, only users with verified emails are allowed.
     */
    public function canAccessWirechatPanel(Panel $panel): bool
    {
        return $this->hasVerifiedEmail();
    }

    /**
     * Control whether this user is allowed to create 1-to-1 chats.
     */
    public function canCreateChats(): bool
    {
        return true;
    }

    /**
     * Control whether this user can create group conversations.
     */
    public function canCreateGroups(): bool
    {
        return true;
    }
}

With both the interface and the trait in place, your model is fully integrated with Wirechat: it can create and join chats, send messages, and respect whatever rules you define for panel and group access.