$Client class

Available extensions

Constructors

$Client(Uri baseURL, {Client? httpClient, List<DynamiteAuthentication>? authentications})
Creates a new DynamiteClient for untagged requests.
$Client.fromClient(DynamiteClient client)
Creates a new $Client from another client.

Properties

authentications List<DynamiteAuthentication>?
The available authentications for this client.
finalinherited
baseURL Uri
The base server url used to build the request uri.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
httpClient → Client
The base http client.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

$addFeed_Request({required String url, int? folderId}) → Request
Returns a DynamiteRequest backing the addFeed operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$addFeed_Serializer() → DynamiteSerializer<ListFeeds, void>
Builds a serializer to parse the response of $addFeed_Request.
$createFolder_Request({required String name}) → Request
Returns a DynamiteRequest backing the createFolder operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$createFolder_Serializer() → DynamiteSerializer<ListFolders, void>
Builds a serializer to parse the response of $createFolder_Request.
$deleteFeed_Request({required int feedId}) → Request
Returns a DynamiteRequest backing the deleteFeed operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$deleteFeed_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $deleteFeed_Request.
$deleteFolder_Request({required int folderId}) → Request
Returns a DynamiteRequest backing the deleteFolder operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$deleteFolder_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $deleteFolder_Request.
$getSupportedApiVersions_Request() → Request
Returns a DynamiteRequest backing the getSupportedApiVersions operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$getSupportedApiVersions_Serializer() → DynamiteSerializer<SupportedAPIVersions, void>
Builds a serializer to parse the response of $getSupportedApiVersions_Request.
$listArticles_Request({int? type, int? id, int? getRead, int? batchSize, int? offset, int? oldestFirst}) → Request
Returns a DynamiteRequest backing the listArticles operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$listArticles_Serializer() → DynamiteSerializer<ListArticles, void>
Builds a serializer to parse the response of $listArticles_Request.
$listFeeds_Request() → Request
Returns a DynamiteRequest backing the listFeeds operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$listFeeds_Serializer() → DynamiteSerializer<ListFeeds, void>
Builds a serializer to parse the response of $listFeeds_Request.
$listFolders_Request() → Request
Returns a DynamiteRequest backing the listFolders operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$listFolders_Serializer() → DynamiteSerializer<ListFolders, void>
Builds a serializer to parse the response of $listFolders_Request.
$listUpdatedArticles_Request({int? type, int? id, int? lastModified}) → Request
Returns a DynamiteRequest backing the listUpdatedArticles operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$listUpdatedArticles_Serializer() → DynamiteSerializer<ListArticles, void>
Builds a serializer to parse the response of $listUpdatedArticles_Request.
$markArticleAsRead_Request({required int itemId}) → Request
Returns a DynamiteRequest backing the markArticleAsRead operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$markArticleAsRead_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $markArticleAsRead_Request.
$markArticleAsUnread_Request({required int itemId}) → Request
Returns a DynamiteRequest backing the markArticleAsUnread operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$markArticleAsUnread_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $markArticleAsUnread_Request.
$markFeedAsRead_Request({required int feedId, required int newestItemId}) → Request
Returns a DynamiteRequest backing the markFeedAsRead operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$markFeedAsRead_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $markFeedAsRead_Request.
$markFolderAsRead_Request({required int folderId, required int newestItemId}) → Request
Returns a DynamiteRequest backing the markFolderAsRead operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$markFolderAsRead_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $markFolderAsRead_Request.
$moveFeed_Request({required int feedId, int? folderId}) → Request
Returns a DynamiteRequest backing the moveFeed operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$moveFeed_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $moveFeed_Request.
$renameFeed_Request({required int feedId, required String feedTitle}) → Request
Returns a DynamiteRequest backing the renameFeed operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$renameFeed_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $renameFeed_Request.
$renameFolder_Request({required int folderId, required String name}) → Request
Returns a DynamiteRequest backing the renameFolder operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$renameFolder_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $renameFolder_Request.
$starArticle_Request({required int itemId}) → Request
Returns a DynamiteRequest backing the starArticle operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$starArticle_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $starArticle_Request.
$unstarArticle_Request({required int itemId}) → Request
Returns a DynamiteRequest backing the unstarArticle operation. Throws a DynamiteApiException if the API call does not return an expected status code.
$unstarArticle_Serializer() → DynamiteSerializer<void, void>
Builds a serializer to parse the response of $unstarArticle_Request.
addFeed({required String url, int? folderId}) Future<DynamiteResponse<ListFeeds, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
createFolder({required String name}) Future<DynamiteResponse<ListFolders, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
deleteFeed({required int feedId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
deleteFolder({required int folderId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
getSupportedApiVersions() Future<DynamiteResponse<SupportedAPIVersions, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
listArticles({int? type, int? id, int? getRead, int? batchSize, int? offset, int? oldestFirst}) Future<DynamiteResponse<ListArticles, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
listFeeds() Future<DynamiteResponse<ListFeeds, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
listFolders() Future<DynamiteResponse<ListFolders, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
listUpdatedArticles({int? type, int? id, int? lastModified}) Future<DynamiteResponse<ListArticles, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
markArticleAsRead({required int itemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
markArticleAsUnread({required int itemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
markFeedAsRead({required int feedId, required int newestItemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
markFolderAsRead({required int folderId, required int newestItemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
moveFeed({required int feedId, int? folderId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
renameFeed({required int feedId, required String feedTitle}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
renameFolder({required int folderId, required String name}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
starArticle({required int itemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.
toString() String
A string representation of this object.
inherited
unstarArticle({required int itemId}) Future<DynamiteResponse<void, void>>
Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Operators

operator ==(Object other) bool
The equality operator.
inherited