$Client class

Available Extensions

• NewsVersionCheck

Constructors

$Client(Uri baseURL, {Map<String, String>? baseHeaders, String? userAgent, HttpClient? httpClient, CookieJar? cookieJar, List<DynamiteAuthentication> authentications = const []})

$Client.fromClient(DynamiteClient client)

Properties

authentications → List<DynamiteAuthentication>

The available authentications for this client.

final, inherited

baseHeaders → Map<String, String>?

The base headers added to each request.

final, inherited

baseURL → Uri

The base server url used to build the request uri.

final, inherited

cookieJar → CookieJar?

The optional cookie jar to persist the response cookies.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

httpClient → HttpClient

The base http client.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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.

addFeedRaw({required String url, int? folderId}) → DynamiteRawResponse<ListFeeds, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

createFolderRaw({required String name}) → DynamiteRawResponse<ListFolders, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

deleteFeedRaw({required int feedId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

deleteFolderRaw({required int folderId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

executeRawRequest(String method, Uri uri, Map<String, String> headers, Uint8List? body, Set<int>? validStatuses) → Future<HttpClientResponse>

Executes a HTTP request against give full uri.

inherited

executeRequest(String method, String path, Map<String, String> headers, Uint8List? body, Set<int>? validStatuses) → Future<HttpClientResponse>

Makes a request against a given path.

inherited

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.

getSupportedApiVersionsRaw() → DynamiteRawResponse<SupportedAPIVersions, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

listArticlesRaw({int? type, int? id, int? getRead, int? batchSize, int? offset, int? oldestFirst}) → DynamiteRawResponse<ListArticles, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

listFeedsRaw() → DynamiteRawResponse<ListFeeds, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

listFoldersRaw() → DynamiteRawResponse<ListFolders, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

listUpdatedArticlesRaw({int? type, int? id, int? lastModified}) → DynamiteRawResponse<ListArticles, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

markArticleAsReadRaw({required int itemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

markArticleAsUnreadRaw({required int itemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

markFeedAsReadRaw({required int feedId, required int newestItemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

markFolderAsReadRaw({required int folderId, required int newestItemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

moveFeedRaw({required int feedId, int? folderId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

renameFeedRaw({required int feedId, required String feedTitle}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

renameFolderRaw({required int folderId, required String name}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

starArticleRaw({required int itemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

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.

unstarArticleRaw({required int itemId}) → DynamiteRawResponse<void, void>

This method and the response it returns is experimental. The API might change without a major version bump.

Operators

operator ==(Object other) → bool

The equality operator.

inherited