ProxyServerCommandServiceClient extends BaseSender implements CommandServiceClientInterface
Class BaseSender
Table of Contents
Interfaces
Methods
- __construct() : mixed
- drop() : Result
- Disconnects the users with the identifiers specified in the $userIds parameter from the document editing service.
- getHttpClientParameters() : array<string|int, mixed>
- performRequest() : Result
- rename() : Result
- Renames the document
Methods
__construct()
public
__construct(string $serviceUrl) : mixed
Parameters
- $serviceUrl : string
drop()
Disconnects the users with the identifiers specified in the $userIds parameter from the document editing service.
public
drop(string $documentKey, array<string|int, mixed> $userIds) : Result
Parameters
- $documentKey : string
-
Document identifier
- $userIds : array<string|int, mixed>
-
Array of user identifiers
Return values
ResultgetHttpClientParameters()
public
getHttpClientParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>performRequest()
public
performRequest(string $action[, array<string|int, mixed> $parameters = [] ]) : Result
Parameters
- $action : string
- $parameters : array<string|int, mixed> = []
Tags
Return values
Resultrename()
Renames the document
public
rename(string $documentKey, string $newName) : Result
Parameters
- $documentKey : string
-
Document identifier
- $newName : string
-
New document name