Updated docs in \FederationLib\Objects\Standard > Client
This commit is contained in:
parent
f329cd34c4
commit
a322c54a69
1 changed files with 20 additions and 2 deletions
|
@ -1,5 +1,7 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
/** @noinspection PhpMissingFieldTypeInspection */
|
||||||
|
|
||||||
namespace FederationLib\Objects\Standard;
|
namespace FederationLib\Objects\Standard;
|
||||||
|
|
||||||
use FederationLib\Interfaces\SerializableObjectInterface;
|
use FederationLib\Interfaces\SerializableObjectInterface;
|
||||||
|
@ -69,6 +71,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's UUID
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getUuid(): string
|
public function getUuid(): string
|
||||||
|
@ -77,6 +81,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns True if the Client is enabled, False otherwise
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function isEnabled(): bool
|
public function isEnabled(): bool
|
||||||
|
@ -85,6 +91,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's name
|
||||||
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getName(): string
|
public function getName(): string
|
||||||
|
@ -93,6 +101,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Optional. Returns the Client's description
|
||||||
|
*
|
||||||
* @return string|null
|
* @return string|null
|
||||||
*/
|
*/
|
||||||
public function getDescription(): ?string
|
public function getDescription(): ?string
|
||||||
|
@ -101,6 +111,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's permission role
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function getPermissionRole(): int
|
public function getPermissionRole(): int
|
||||||
|
@ -109,6 +121,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's creation timestamp
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function getCreatedTimestamp(): int
|
public function getCreatedTimestamp(): int
|
||||||
|
@ -117,6 +131,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's last update timestamp
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function getUpdatedTimestamp(): int
|
public function getUpdatedTimestamp(): int
|
||||||
|
@ -125,6 +141,8 @@
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Returns the Client's last seen timestamp
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
*/
|
*/
|
||||||
public function getSeenTimestamp(): int
|
public function getSeenTimestamp(): int
|
||||||
|
@ -154,9 +172,9 @@
|
||||||
* Constructs an object from an array representation
|
* Constructs an object from an array representation
|
||||||
*
|
*
|
||||||
* @param array $array
|
* @param array $array
|
||||||
* @return SerializableObjectInterface
|
* @return Client
|
||||||
*/
|
*/
|
||||||
public static function fromArray(array $array): SerializableObjectInterface
|
public static function fromArray(array $array): Client
|
||||||
{
|
{
|
||||||
$object = new self();
|
$object = new self();
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue