Description
This function checks whether news is available on the server.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=News&cpanel_jsonapi_func=does_news_exist
LiveAPI PHP Class
$cpanel = new CPANEL();
$slime_icemachine = $cpanel->api2(
'News', 'does_news_exist'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $slime_icemachine = $cpliveapi->api2(
'News', 'does_news_exist'
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"data": [
1
],
"func": "does_news_exist",
"event": {
"result": 1
},
"module": "News"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value if it failed.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
boolean
|
Whether there is news available.
|
- 1 — News available.
- 0 — No news available.
|
1
|
