-
-
Notifications
You must be signed in to change notification settings - Fork 78
/
MessengerProvider.php
76 lines (66 loc) · 1.78 KB
/
MessengerProvider.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?php
namespace RTippin\Messenger\Contracts;
use Illuminate\Database\Eloquent\Model;
/**
* @mixin Model|\Eloquent
*/
interface MessengerProvider
{
const OFFLINE = 0;
const ONLINE = 1;
const AWAY = 2;
const ONLINE_STATUS = [
0 => 'OFFLINE',
1 => 'ONLINE',
2 => 'AWAY',
];
/**
* Get the provider settings and alias override, if set.
*
* @return array
*/
public static function getProviderSettings(): array;
/**
* Format and return your provider name here.
* ex: $this->first . ' ' . $this->last.
*
* @return string
*/
public function getProviderName(): string;
/**
* The column name your provider's avatar is stored in the database as.
*
* @return string
*/
public function getProviderAvatarColumn(): string;
/**
* The column name your provider has in the database that we will use to
* show last active, and touch / update timestamp when using our online
* heartbeat. This should be a timestamp column.
*
* @return string
*/
public function getProviderLastActiveColumn(): string;
/**
* Get the route of the avatar for your provider. We will call this
* from our resource classes using sm/md/lg .
*
* @param string $size
* @return string|null
*/
public function getProviderAvatarRoute(string $size = 'sm'): ?string;
/**
* If your provider has a route/slug for a profile page,
* return that route here.
*
* @return string|null
*/
public function getProviderProfileRoute(): ?string;
/**
* Returns online status of your provider.
* 0 - offline, 1 - online, 2 - away.
*
* @return int
*/
public function getProviderOnlineStatus(): int;
}