TeamPiped-mirror/piped_dart
1
0
Fork 0
mirror of https://github.com/TeamPiped/piped_dart.git synced 2024-08-14 22:27:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

Regenerate bindings for comments.

Browse source
This commit is contained in:
Kavin 2022-06-25 10:55:47 +01:00
parent 70f4ecc760
commit abb6f6e71c
No known key found for this signature in database
GPG key ID: 49451E4482CC5BCD
15 changed files with 1092 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/Comment.md Normal file
View file

@ -0,0 +1,25 @@
# piped_api.model.Comment
## Load the model package
```dart
import 'package:piped_api/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | **String** | The name of the author of the comment. | [optional]
**thumbnail** | **String** | The thumbnail/avatar of the author of the comment. | [optional]
**commentId** | **String** | The ID of the comment. | [optional]
**commentText** | **String** | The text of the comment. | [optional]
**commentedTime** | **String** | The relative time the comment was made. | [optional]
**commentorUrl** | **String** | The relative URL of the author of the comment. | [optional]
**repliesPage** | **String** | The parameter used as the nextpage to fetch replies for this comment. | [optional]
**likeCount** | **int** | The number of likes the comment has. | [optional]
**hearted** | **bool** | Whether the comment was hearted by the video's uploader. | [optional]
**pinned** | **bool** | Whether the comment was pinned by the video's uploader. | [optional]
**verified** | **bool** | Whether the author of the comment is verified. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
doc/CommentsPage.md Normal file
View file

@ -0,0 +1,17 @@
# piped_api.model.CommentsPage
## Load the model package
```dart
import 'package:piped_api/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments** | [**BuiltList<Comment>**](Comment.md) | | [optional]
**nextpage** | **String** | The parameter used to get the next page of comments. | [optional]
**disabled** | **bool** | Whether or not comments are disabled on the video. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

90
doc/UnauthenticatedApi.md
View file

@ -13,6 +13,8 @@ Method | HTTP request | Description
[**channelInfoName**](UnauthenticatedApi.md#channelinfoname) | **GET** /c/{name} | Gets Channel Information
[**channelInfoUsername**](UnauthenticatedApi.md#channelinfousername) | **GET** /user/{username} | Gets Channel Information
[**channelNextPage**](UnauthenticatedApi.md#channelnextpage) | **GET** /nextpage/channel/{channelId} | Gets more channel videos
[**comments**](UnauthenticatedApi.md#comments) | **GET** /comments/{videoId} | Gets Comments
[**commentsNextPage**](UnauthenticatedApi.md#commentsnextpage) | **GET** /nextpage/comments/{videoId} | Gets more comments
[**streamInfo**](UnauthenticatedApi.md#streaminfo) | **GET** /streams/{videoId} | Gets Video Information
[**trending**](UnauthenticatedApi.md#trending) | **GET** /trending | Gets all Trending Videos
@ -191,6 +193,94 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **comments**
> CommentsPage comments(videoId)
Gets Comments
Gets the comments for a video.
### Example
```dart
import 'package:piped_api/api.dart';
final api = PipedApi().getUnauthenticatedApi();
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get comments from.
try {
final response = api.comments(videoId);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->comments: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**videoId** | **String**| The video ID of the YouTube video you want to get comments from. |
### Return type
[**CommentsPage**](CommentsPage.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **commentsNextPage**
> CommentsPage commentsNextPage(videoId, nextpage)
Gets more comments
Gets more comments.
### Example
```dart
import 'package:piped_api/api.dart';
final api = PipedApi().getUnauthenticatedApi();
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get more comments from.
final String nextpage = nextpage_example; // String | The next page token to get more comments from.
try {
final response = api.commentsNextPage(videoId, nextpage);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->commentsNextPage: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**videoId** | **String**| The video ID of the YouTube video you want to get more comments from. |
**nextpage** | **String**| The next page token to get more comments from. |
### Return type
[**CommentsPage**](CommentsPage.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **streamInfo**
> VideoInfo streamInfo(videoId)