meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Common-Exceptions-ApiException.md

128 lines
3.3 KiB
Markdown
Raw Normal View History

# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Common\Exceptions\ApiException
### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md)
---
**Summary:**
Неожиданный код ошибки.
---
### Constants
* No constants found
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | |
| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Common-Exceptions-ApiException.md#method___construct) | | Constructor |
| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | |
| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | |
---
### Details
* File: [lib/Common/Exceptions/ApiException.php](../../lib/Common/Exceptions/ApiException.php)
* Package: YooKassa
* Class Hierarchy:
* [\Exception](\Exception)
* \YooKassa\Common\Exceptions\ApiException
---
## Properties
<a name="property_responseBody"></a>
#### protected $responseBody : mixed
---
**Type:** <a href="mixed"><abbr title="mixed">mixed</abbr></a>
**Details:**
<a name="property_responseHeaders"></a>
#### protected $responseHeaders : string[]
---
**Type:** <a href="string[]"><abbr title="string[]">string[]</abbr></a>
**Details:**
---
## Methods
<a name="method___construct" class="anchor"></a>
#### public __construct() : mixed
```php
public __construct(string $message = &quot;&quot;, int $code, string[] $responseHeaders = array(), mixed $responseBody = null) : mixed
```
**Summary**
Constructor
**Details:**
* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | message | Error message |
| <code lang="php">int</code> | code | HTTP status code |
| <code lang="php">string[]</code> | responseHeaders | HTTP header |
| <code lang="php">mixed</code> | responseBody | HTTP body |
**Returns:** mixed -
<a name="method_getResponseBody" class="anchor"></a>
#### public getResponseBody() : mixed
```php
public getResponseBody() : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md)
**Returns:** mixed -
<a name="method_getResponseHeaders" class="anchor"></a>
#### public getResponseHeaders() : string[]
```php
public getResponseHeaders() : string[]
```
**Details:**
* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md)
**Returns:** string[] -
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 1](../reports/markers.md)
* [Deprecated - 25](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2023 YooMoney