Nextcloud PHP API (master)

BadRequestException extends HintException
in package

Class BadRequestException

Tags
since
14.0.0

Table of Contents

Properties

$hint  : mixed
$parameterList  : array<string|int, string>

Methods

__construct()  : mixed
BadRequestException constructor.
__toString()  : string
Returns a string representation of this Exception that includes the error code, the message and the hint.
getHint()  : string
Returns the hint with the intention to be presented to the end user. If an empty hint was specified upon instantiation, the message is returned instead.
getReturnMessage()  : array{message: string, validationErrors: array{message: string, name: string}[]}
get array with the return message as defined in the OCM API

Properties

Methods

__construct()

BadRequestException constructor.

public __construct(array<string|int, mixed> $missingParameters) : mixed
Parameters
$missingParameters : array<string|int, mixed>
Tags
since
14.0.0

__toString()

Returns a string representation of this Exception that includes the error code, the message and the hint.

public __toString() : string
Tags
since
23.0.0
Return values
string

getHint()

Returns the hint with the intention to be presented to the end user. If an empty hint was specified upon instantiation, the message is returned instead.

public getHint() : string
Tags
since
23.0.0
Return values
string

getReturnMessage()

get array with the return message as defined in the OCM API

public getReturnMessage() : array{message: string, validationErrors: array{message: string, name: string}[]}
Tags
since
14.0.0
Return values
array{message: string, validationErrors: array{message: string, name: string}[]}

        
On this page

Search results