5
5
* ** INVALID_CLIENT_SECRET**
6
6
* ** INVALID_REFRESH_TOKEN**
7
7
* ** TOKEN_EXPIRED**
8
+ * ** RATE_LIMIT_STATUS**
8
9
9
10
## Methods
10
11
### hasInvalidCredentials
14
15
SpotifyWebAPIAuthException::hasInvalidCredentials()
15
16
```
16
17
17
- Returns if the exception was thrown because of invalid credentials.
18
+ Returns whether the exception was thrown because of invalid credentials.
18
19
19
20
20
21
#### Return values
@@ -28,7 +29,7 @@ Returns if the exception was thrown because of invalid credentials.
28
29
SpotifyWebAPIAuthException::hasInvalidRefreshToken()
29
30
```
30
31
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.
32
33
33
34
34
35
#### Return values
@@ -42,7 +43,7 @@ Returns if the exception was thrown because of invalid refresh token.
42
43
SpotifyWebAPIAuthException::getReason()
43
44
```
44
45
45
- Returns the reason string from the requests error object
46
+ Returns the reason string from the request's error object.
46
47
47
48
48
49
#### Return values
@@ -56,7 +57,21 @@ Returns the reason string from the requests error object
56
57
SpotifyWebAPIAuthException::hasExpiredToken()
57
58
```
58
59
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.
60
75
61
76
62
77
#### Return values
@@ -70,10 +85,12 @@ Returns if the exception was thrown because of an expired token.
70
85
SpotifyWebAPIAuthException::setReason($reason)
71
86
```
72
87
73
- Set the reason string
88
+ Set the reason string.
74
89
75
90
#### Arguments
76
91
* ` $reason ` ** string**
77
92
93
+ #### Return values
94
+ * ** void**
78
95
79
96
---
0 commit comments