manual:api:reference:hostprototype:iswritable
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
manual:api:reference:hostprototype:iswritable [2016/11/25 10:05] sasha removed deprecated method |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== hostprototype.iswritable ===== | ||
| - | |||
| - | ==== Description ==== | ||
| - | |||
| - | ''boolean hostprototype.iswritable(array **hostPrototypeIds**)'' | ||
| - | |||
| - | This method checks if the given host prototypes are available for writing. | ||
| - | |||
| - | <note warning>This method is deprecated and will be removed in the future. Please use [[get|hostprototype.get]] instead.</note> | ||
| - | ==== Parameters ==== | ||
| - | |||
| - | ''(array)'' IDs of the host prototypes to check. | ||
| - | |||
| - | ==== Return values ==== | ||
| - | |||
| - | ''(boolean)'' Returns ''true'' if the given host prototypes are available for writing. | ||
| - | |||
| - | ==== Examples ==== | ||
| - | |||
| - | === Check multiple host prototypes === | ||
| - | |||
| - | Check if the two host prototypes are writable. | ||
| - | |||
| - | Request: | ||
| - | <code js> | ||
| - | { | ||
| - | "jsonrpc": "2.0", | ||
| - | "method": "hostprototype.iswritable", | ||
| - | "params": [ | ||
| - | "10092", | ||
| - | "10093" | ||
| - | ], | ||
| - | "auth": "038e1d7b1735c6a5436ee9eae095879e", | ||
| - | "id": 1 | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | Response: | ||
| - | <code js> | ||
| - | { | ||
| - | "jsonrpc": "2.0", | ||
| - | "result": true, | ||
| - | "id": 1 | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | ==== See also ==== | ||
| - | |||
| - | * [[isreadable|hostprototype.isreadable]] | ||
| - | |||
| - | ==== Source ==== | ||
| - | |||
| - | CHostPrototype::isWritable() in //frontends/php/include/classes/api/services/CHostPrototype.php//. | ||