Updated docs in \FederationLib\Objects\Standard > Client

This commit is contained in:
Netkas 2023-06-19 17:50:06 -04:00
parent f329cd34c4
commit a322c54a69
No known key found for this signature in database
GPG key ID: 5DAF58535614062B

View file

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