Home

Usage

Include the Facade class at the top of your file

use Chatkit;

After that, authenticate your user with the api

Chatkit::withUser($userId);

Some api calls require a sudo token. You can easily authenticate has a sudo user like this.

Chatkit::withSudoUser($userId);

That's it. You can now build something amazing.

Example

Route::get('chatkit/api/get-user', function () {
    Chatkit::withUser($userId);

    $chatkitUser = Chatkit::users()->show($chatkitUserId);

    dd($chatkitUser);
});

Contents

• Users

  • Creating a User
  • Batch Creating Users
  • Get User
  • Get Users
  • Get Users by IDs
  • Updating a User
  • Deleting a User
  • Get User Rooms
  • Join a Room
  • Leave a Room

• Rooms

  • Create a Room
  • Fetch a Room
  • Fetch Rooms
  • Delete a Room
  • Update a Room
  • Add Users
  • Remove Users

• Messages

  • Sending Messages
  • Fetch Messages From a Room
  • Typing Indicators

• Roles & Permissions

  • Get Roles
  • Deleting a Role
  • Setting a User Role
  • Get User Roles
  • Delete User Role
  • Get Role Permissions
  • Add Role Permissions
  • Remove Role Permissions

• Files

  • Get File
  • Post File
  • Delete File
  • Delete User Files

• Cursors

  • Set a Cursor
  • Get a Cursor
  • Get Cursors by User
  • Get Cursors by Room

Tokens

Caching

Middlewares

The goal of this package is to extends the capacity of the official PHP SDK and give access to the entire api functionalities with a clean laravel-like syntax.

The official pusher chatkit api documentation can be found here.