Skip to content

Commit 5bb2c0d

Browse files
committed
Regenerate docs for 2.12.0
1 parent 11e2e80 commit 5bb2c0d

File tree

2 files changed

+42
-8
lines changed

2 files changed

+42
-8
lines changed

docs/method-reference/SpotifyWebAPIAuthException.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* **INVALID_CLIENT_SECRET**
66
* **INVALID_REFRESH_TOKEN**
77
* **TOKEN_EXPIRED**
8+
* **RATE_LIMIT_STATUS**
89

910
## Methods
1011
### hasInvalidCredentials
@@ -14,7 +15,7 @@
1415
SpotifyWebAPIAuthException::hasInvalidCredentials()
1516
```
1617

17-
Returns if the exception was thrown because of invalid credentials.
18+
Returns whether the exception was thrown because of invalid credentials.
1819

1920

2021
#### Return values
@@ -28,7 +29,7 @@ Returns if the exception was thrown because of invalid credentials.
2829
SpotifyWebAPIAuthException::hasInvalidRefreshToken()
2930
```
3031

31-
Returns if the exception was thrown because of invalid refresh token.
32+
Returns whether the exception was thrown because of an invalid refresh token.
3233

3334

3435
#### Return values
@@ -42,7 +43,7 @@ Returns if the exception was thrown because of invalid refresh token.
4243
SpotifyWebAPIAuthException::getReason()
4344
```
4445

45-
Returns the reason string from the requests error object
46+
Returns the reason string from the request's error object.
4647

4748

4849
#### Return values
@@ -56,7 +57,21 @@ Returns the reason string from the requests error object
5657
SpotifyWebAPIAuthException::hasExpiredToken()
5758
```
5859

59-
Returns if the exception was thrown because of an expired token.
60+
Returns whether the exception was thrown because of an expired access token.
61+
62+
63+
#### Return values
64+
* **boolean**
65+
66+
---
67+
### isRateLimited
68+
69+
70+
```php
71+
SpotifyWebAPIAuthException::isRateLimited()
72+
```
73+
74+
Returns whether the exception was thrown because of rate limiting.
6075

6176

6277
#### Return values
@@ -70,10 +85,12 @@ Returns if the exception was thrown because of an expired token.
7085
SpotifyWebAPIAuthException::setReason($reason)
7186
```
7287

73-
Set the reason string
88+
Set the reason string.
7489

7590
#### Arguments
7691
* `$reason` **string**
7792

93+
#### Return values
94+
* **void**
7895

7996
---

docs/method-reference/SpotifyWebAPIException.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Constants
44
* **TOKEN_EXPIRED**
5+
* **RATE_LIMIT_STATUS**
56

67
## Methods
78
### getReason
@@ -11,7 +12,7 @@
1112
SpotifyWebAPIException::getReason()
1213
```
1314

14-
Returns the reason string from the requests error object
15+
Returns the reason string from the request's error object.
1516

1617

1718
#### Return values
@@ -25,7 +26,21 @@ Returns the reason string from the requests error object
2526
SpotifyWebAPIException::hasExpiredToken()
2627
```
2728

28-
Returns if the exception was thrown because of an expired token.
29+
Returns whether the exception was thrown because of an expired access token.
30+
31+
32+
#### Return values
33+
* **boolean**
34+
35+
---
36+
### isRateLimited
37+
38+
39+
```php
40+
SpotifyWebAPIException::isRateLimited()
41+
```
42+
43+
Returns whether the exception was thrown because of rate limiting.
2944

3045

3146
#### Return values
@@ -39,10 +54,12 @@ Returns if the exception was thrown because of an expired token.
3954
SpotifyWebAPIException::setReason($reason)
4055
```
4156

42-
Set the reason string
57+
Set the reason string.
4358

4459
#### Arguments
4560
* `$reason` **string**
4661

62+
#### Return values
63+
* **void**
4764

4865
---

0 commit comments

Comments
 (0)