NAME
cPanel::APIClient::Response::UAPI
SYNOPSIS
See cPanel::APIClient::Service::cpanel.
DESCRIPTION
This class represents a response to a cPanel UAPI request.
METHODS
$yn = OBJ->succeeded()
Returns a boolean that indicates whether the request succeeded.
$scalar = OBJ->get_data()
Returns the response’s payload. If that payload is a structure, then a reference to that structure is returned.
$str = OBJ->get_errors_as_string()
Returns a single string with all of the response’s errors concatenated.
@errs = OBJ->get_errors()
Returns a list of all the response’s errors.
Must be called in list context.
@warnings = OBJ->get_warnings()
Like get_errors() but returns warnings.
@messages = OBJ->get_messages()
Like get_errors() but returns informational messages.
LICENSE
Copyright 2020 cPanel, L. L. C. All rights reserved. http://cpanel.net
This is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.