СправочникRequests
SubUserRequest v1.0.0
SubUserRequest
Описание: SubUserRequest
Namespace: Devcraft\Webshare\Requests
Extends: AbstractRequest
С версии: 1.0.0
См. также:
Endpoint: subuser
Query fields:
- optional:
plan_id,ordering,label
Методы
__construct(): void
Возвращает: void
list(): SubUserList
Возвращает: SubUserList
iterate(): Generator
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$maxPages | ?int | Лимит страниц iterate; по умолчанию App::iterateMaxPages(). По умолчанию: NULL. |
Возвращает: Generator
retrieve(): SubUser
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
Возвращает: SubUser
create(): SubUser
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$label | string | Метка. |
$proxyLimit | ?float | Лимит прокси. По умолчанию: NULL. |
$maxThreadCount | ?int | Лимит потоков. По умолчанию: NULL. |
Возвращает: SubUser
update(): SubUser
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
$fields | array | Поля ordering или списки fields. |
Возвращает: SubUser
delete(): void
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
Возвращает: void
refreshProxyList(): SubUser
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
Возвращает: SubUser
masqueradeAs(): void
Описание: Masquerade subsequent App::Client() calls as this sub-user (X-Subuser header).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$subuserId | int | string | null | ID SubUser для заголовка X-Subuser. |
Возвращает: void