PHP Класс PHPDaemon\Clients\XMPP\XMPPRoster

Наследование: use trait PHPDaemon\Traits\EventHandlers, use trait PHPDaemon\Traits\ClassWatchdog, use trait PHPDaemon\Traits\StaticObjectWatchdog
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$auto_subscribe boolean
$ns string
$roster_array array
$track_presence boolean
$xmpp Connection

Открытые методы

Метод Описание
__construct ( Connection $xmpp ) Constructor
_addContact ( string $jid, string $subscription, string $name = '', array $groups = [] ) Add given contact to roster
fetch ( callable $cb = null )
getContact ( string $jid ) : array | null Retrieve contact via jid
getPresence ( string $jid ) : array | false Return best presence for jid
isContact ( string $jid ) : boolean Discover if a contact exists in the roster via jid
rosterSet ( string $xml, callable $cb = null )
setPresence ( string $presence, integer $priority, string $show, string $status ) Set presence
setSubscription ( string $jid, string $type, callable $cb = null )

Описание методов

__construct() публичный Метод

Constructor
public __construct ( Connection $xmpp )
$xmpp Connection

_addContact() публичный Метод

Add given contact to roster
public _addContact ( string $jid, string $subscription, string $name = '', array $groups = [] )
$jid string
$subscription string
$name string
$groups array

fetch() публичный Метод

public fetch ( callable $cb = null )
$cb callable

getContact() публичный Метод

Retrieve contact via jid
public getContact ( string $jid ) : array | null
$jid string
Результат array | null

getPresence() публичный Метод

Return best presence for jid
public getPresence ( string $jid ) : array | false
$jid string
Результат array | false

isContact() публичный Метод

Discover if a contact exists in the roster via jid
public isContact ( string $jid ) : boolean
$jid string
Результат boolean

rosterSet() публичный Метод

public rosterSet ( string $xml, callable $cb = null )
$xml string
$cb callable

setPresence() публичный Метод

Set presence
public setPresence ( string $presence, integer $priority, string $show, string $status )
$presence string
$priority integer
$show string
$status string

setSubscription() публичный Метод

public setSubscription ( string $jid, string $type, callable $cb = null )
$jid string
$type string
$cb callable

Описание свойств

$auto_subscribe публичное свойство

public bool $auto_subscribe
Результат boolean

$ns публичное свойство

public string $ns
Результат string

$roster_array публичное свойство

public array $roster_array
Результат array

$track_presence публичное свойство

public bool $track_presence
Результат boolean

$xmpp публичное свойство

public Connection,PHPDaemon\Clients\XMPP $xmpp
Результат Connection