Skip to content
This repository has been archived by the owner on Oct 8, 2019. It is now read-only.

Cursors

Pascal Boucher edited this page Jun 11, 2018 · 1 revision

Shortcuts

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

Set a Cursor

@param  int $roomId
@param  string $userId
@param  int $position
@return \Chess\Chatkit\Models\Cursor

position (integer|required): The message ID that the user has read up to

Example

$room = new \Chess\Chatkit\Models\Room($roomId);

$cursor = $room->user($userId)->cursors()->position($position);

Api reference

Get a Cursor

@param  int $roomId
@param  string $userId
@return \Chess\Chatkit\Models\Cursor

Example

$room = new \Chess\Chatkit\Models\Room($roomId);

$cursor = $room->user($userId)->cursors()->first();

Api reference

Get Cursors by User

@param  string $userId
@return \Illuminate\Support\Collection

Example

$user = new \Chess\Chatkit\Models\User($userId);

$cursors = $user->cursors()->get();

Api reference

Get Cursors by Room

@param  int $roomId
@return \Illuminate\Support\Collection

Example

$room = new \Chess\Chatkit\Models\Room($roomId);

$cursors = $room->cursors()->get();

Api reference

Clone this wiki locally