New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Combine error callbacks #377
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package com.vimeo.networking2 | ||
|
||
import com.vimeo.networking2.VimeoResponse.Error | ||
import com.vimeo.networking2.VimeoResponse.Success | ||
|
||
/** | ||
* Result of the API response. [Success] contains the data while the [Error] class will | ||
* inform you of an api error. | ||
*/ | ||
sealed class VimeoResponse<out T> { | ||
|
||
/** | ||
* A successful response. | ||
* | ||
* @param data The parsed data for the request. | ||
*/ | ||
data class Success<out T>(val data: T) : VimeoResponse<T>() | ||
|
||
/** | ||
* An error occurred when making the request. This error may be due to invalid parameters, | ||
* exception thrown when making the request or there was an error parsing the response. | ||
* | ||
* @param message The error message. | ||
*/ | ||
sealed class Error(val message: String): VimeoResponse<Nothing>() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔥 |
||
|
||
/** | ||
* Vimeo API returned an error response for the request you made. | ||
* | ||
* @param reason Info on the error. | ||
*/ | ||
data class Api(val reason: ApiError): Error("API error: ${reason.errorCode ?: "unknown"}") | ||
|
||
/** | ||
* Exception was thrown when making the request. This maybe due to no internet. | ||
* | ||
* @param throwable Info on the exception that was thrown. | ||
*/ | ||
data class Exception(val throwable: Throwable): Error("Exception thrown") | ||
|
||
/** | ||
* Generic error occurred. The request was successful, but the response could not be | ||
* parsed by the SDK. This is maybe because it is not formatted correctly. The raw response | ||
* will allow you to see info about the request. | ||
* | ||
* @param httpStatusCode HTTP status code. | ||
* @param rawResponse Raw response from the API. | ||
*/ | ||
data class Generic(val httpStatusCode: Int, val rawResponse: String): Error("Generic error") | ||
|
||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good for both Java and Kotlin consumers!