Migrate /unvip to Helix API (#4025)

Co-authored-by: iProdigy <iProdigy@users.noreply.github.com>
Co-authored-by: pajlada <rasmus.karlsson@pajlada.com>
This commit is contained in:
Aiden
2022-10-01 15:00:45 +01:00
committed by GitHub
parent bfcc9ff7a4
commit adbc4690af
5 changed files with 203 additions and 0 deletions
+78
View File
@@ -1257,6 +1257,84 @@ void Helix::addChannelVIP(
.execute();
}
void Helix::removeChannelVIP(
QString broadcasterID, QString userID, ResultCallback<> successCallback,
FailureCallback<HelixRemoveChannelVIPError, QString> failureCallback)
{
using Error = HelixRemoveChannelVIPError;
QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("user_id", userID);
this->makeRequest("channels/vips", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204)
{
qCWarning(chatterinoTwitch)
<< "Success result for removing channel VIP was"
<< result.status() << "but we only expected it to be 204";
}
successCallback();
return Success;
})
.onError([failureCallback](auto result) {
auto obj = result.parseJson();
auto message = obj.value("message").toString();
switch (result.status())
{
case 400:
case 409:
case 422: {
// Most of the errors returned by this endpoint are pretty good. We can rely on Twitch's API messages
failureCallback(Error::Forwarded, message);
}
break;
case 401: {
if (message.startsWith("Missing scope",
Qt::CaseInsensitive))
{
// Handle this error specifically because its API error is especially unfriendly
failureCallback(Error::UserMissingScope, message);
}
else if (message.compare("incorrect user authorization",
Qt::CaseInsensitive) == 0 ||
message.startsWith("the id in broadcaster_id must "
"match the user id",
Qt::CaseInsensitive))
{
// This error is particularly ugly, but is the equivalent to a user not having permissions
failureCallback(Error::UserNotAuthorized, message);
}
else
{
failureCallback(Error::Forwarded, message);
}
}
break;
case 429: {
failureCallback(Error::Ratelimited, message);
}
break;
default: {
qCDebug(chatterinoTwitch)
<< "Unhandled error removing channel VIP:"
<< result.status() << result.getData() << obj;
failureCallback(Error::Unknown, message);
}
break;
}
})
.execute();
}
NetworkRequest Helix::makeRequest(QString url, QUrlQuery urlQuery)
{
assert(!url.startsWith("/"));
+22
View File
@@ -391,6 +391,16 @@ enum class HelixAddChannelVIPError {
Forwarded,
};
enum class HelixRemoveChannelVIPError {
Unknown,
UserMissingScope,
UserNotAuthorized,
Ratelimited,
// The error message is forwarded directly from the Twitch API
Forwarded,
};
class IHelix
{
public:
@@ -551,6 +561,12 @@ public:
QString broadcasterID, QString userID, ResultCallback<> successCallback,
FailureCallback<HelixAddChannelVIPError, QString> failureCallback) = 0;
// https://dev.twitch.tv/docs/api/reference#remove-channel-vip
virtual void removeChannelVIP(
QString broadcasterID, QString userID, ResultCallback<> successCallback,
FailureCallback<HelixRemoveChannelVIPError, QString>
failureCallback) = 0;
virtual void update(QString clientId, QString oauthToken) = 0;
};
@@ -705,6 +721,12 @@ public:
FailureCallback<HelixAddChannelVIPError, QString>
failureCallback) final;
// https://dev.twitch.tv/docs/api/reference#remove-channel-vip
void removeChannelVIP(QString broadcasterID, QString userID,
ResultCallback<> successCallback,
FailureCallback<HelixRemoveChannelVIPError, QString>
failureCallback) final;
void update(QString clientId, QString oauthToken) final;
static void initialize();