MangadexClient class
Properties
-
autoRefresh
→ bool
-
whether to automatically refresh the user tokens or not
final
-
hashCode
→ int
-
The hash code for this object.
read-onlyinherited
-
onRefresh
→ (void Function()?)
-
A function that executes on successful refresh of token
final
-
refreshDuration
→ Duration?
-
interval between token refreshes
defaults to 14 minutes
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
addMangaToCustomList(String sessionToken, String mangaId, String listId)
→ Future<Result>
-
Endpoint used:
POST /manga/{id}/list/{id}
inherited
-
addMangaToCustomListResponse(String sessionToken, String mangaId, String listId)
→ Future<Response>
-
Endpoint used:
POST /manga/{id}/list/{id}
inherited
-
checkIfUserFollowsGroup(String sessionToken, String groupId)
→ Future<bool>
-
Endpoint used:
GET /user/follows/group/{id}
inherited
-
checkIfUserFollowsGroupResponse(String sessionToken, String groupId)
→ Future<Response>
-
Endpoint used:
GET /user/follows/group/{id}
inherited
-
checkIfUserFollowsManga(String sessionToken, String mangaId)
→ Future<bool>
-
Endpoint used:
GET /user/follows/manga/{id}
inherited
-
checkIfUserFollowsMangaResponse(String sessionToken, String mangaId)
→ Future<Response>
-
Endpoint used:
GET /user/follows/manga/{id}
inherited
-
checkIfUserFollowsUser(String sessionToken, String userId)
→ Future<bool>
-
Endpoint used:
GET /user/follows/user/{id}
inherited
-
checkIfUserFollowsUserResponse(String sessionToken, String userId)
→ Future<Response>
-
Endpoint used:
GET /user/follows/user/{id}
inherited
-
checkToken(String sessionToken)
→ Future<AuthenticationCheck>
-
Endpoint used:
GET /auth/check
inherited
-
checkTokenResponse(String sessionToken)
→ Future<Response>
-
Endpoint used:
GET /auth/check
inherited
-
constructPageUrl(String baseUrl, bool dataSaver, String chapterHash, String filename)
→ String
-
-
createCustomList(String sessionToken, String listName, Visibility visibility, List<String> mangaIds, int version)
→ Future<SingleCustomListResponse>
-
Endpoint used:
POST /list
inherited
-
createCustomListResponse(String sessionToken, String listName, Visibility visibility, List<String> mangaIds, int version)
→ Future<Response>
-
Endpoint used:
POST /list
inherited
-
createScanlationGroup({required String name, required String website, required String ircServer, required String ircChannel, required String discord, required String contactEmail, required String description, required String mangaUpdates, required bool inactive, required String publishDelay, required String sessionToken})
→ Future<Scanlation>
-
Endpoint used:
POST /group
inherited
-
createScanlationGroupResponse(String name, String website, String ircServer, String ircChannel, String discord, String contactEmail, String description, String mangaUpdates, bool inactive, String publishDelay, String sessionToken)
→ Future<Response>
-
Endpoint used:
POST /group
inherited
-
deleteCustomList(String sessionToken, String listId)
→ Future<Result>
-
Endpoint used:
DELETE /list/{id}
inherited
-
deleteCustomListResponse(String sessionToken, String listId)
→ Future<Response>
-
Endpoint used:
DELETE /list/{id}
inherited
-
dispose()
→ void
-
-
followCustomList(String sessionToken, String listId)
→ Future<Result>
-
Endpoint used:
POST /list/{id}/follow
inherited
-
followCustomListResponse(String sessionToken, String listId)
→ Future<Response>
-
Endpoint used:
POST /list/{id}/follow
inherited
-
followManga(String sessionToken, String mangaId, {ReadingStatus? readingStatus})
→ Future<Result>
-
Endpoint used:
POST /manga/{id}/follow
inherited
-
getAllMangaReadingStatusResponse(String sessionToken, String? status)
→ Future<Response>
-
Endpoint used:
GET /manga/status
inherited
-
getAllReadChapters(String sessionToken, String mangaId)
→ Future<ReadChapters>
-
Returns a
ReadChapters
class instance containing details
of all read chapters of a manga
inherited
-
getAllReadChaptersForAListOfManga(String sessionToken, List<String> mangaIds)
→ Future<Response>
-
Returns a http response with details of all read chapters in the list of given
mangaIds
or uuids,
please note it returns a http response since the response is not always of the same schema.
inherited
-
getAllUserMangaReadingStatus(String sessionToken, {ReadingStatus? readingStatus})
→ Future<AllMangaReadingStatus>
-
Endpoint used:
GET /manga/status
inherited
-
getAuthorById(String authorId)
→ Future<AuthorInfo>
-
Endpoint used:
GET /author/{id}
inherited
-
getAuthorByIdResponse(String authorId)
→ Future<Response>
-
Get details of an author identified by the author's
authorId
or UUID nad return the data as an http response.
inherited
-
getBaseUrl(String chapterId)
→ Future<BaseUrl>
-
Endpoint used:
GET /at-home/server/{id}
inherited
-
getBaseUrlResponse(String chapterId)
→ Future<Response>
-
Endpoint used:
GET /at-home/server/{id}
inherited
-
getChapters(String mangaId, {List<String>? ids, String? title, List<String>? groups, String? uploader, String? volume, String? chapter, List<LanguageCodes>? translatedLanguage, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguage, List<ContentRating>? contentRating, String? createdAtSince, String? updatedAtSince, String? publishedAtSince, String? includes, Map<ChapterOrders, OrderDirections>? orders, int? limit, int? offset})
→ Future<ChapterData>
-
Endpoint used:
GET /chapter
inherited
-
getChaptersResponse(String mangaId, {List<String>? ids, String? title, List<String>? groups, String? uploader, String? volume, String? chapter, List<LanguageCodes>? translatedLanguage, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguage, List<ContentRating>? contentRating, String? createdAtSince, String? updatedAtSince, String? publishedAtSince, String? includes, Map<ChapterOrders, OrderDirections>? orders, int? limit, int? offset})
→ Future<Response>
-
Endpoint used:
GET /chapter
inherited
-
getCoverArt(List<String> mangaIds, {List<String>? coverIds, List<String>? uploaders, List<String>? locales, Map<CoverOrders, OrderDirections>? order, int? limit, int? offset})
→ Future<Cover>
-
Endpoint used:
GET /cover
inherited
-
getCoverArtResponse(List<String> mangaIds, [List<String>? coverIds, List<String>? uploaders, List<String>? locales, Map<CoverOrders, OrderDirections>? orders, int? limit, int? offset])
→ Future<Response>
-
Endpoint used:
GET /cover
inherited
-
getLoggedInUserCustomLists(String sessionToken, int? limit, int? offset)
→ Future<SingleCustomListResponse>
-
Endpoint used:
GET /user/list
inherited
-
getLoggedInUserCustomListsResponse(String sessionToken, int? limit, int? offset)
→ Future<Response>
-
Endpoint used:
GET /user/list
inherited
-
getLoggedUserDetails(String sessionToken)
→ Future<UserDetails>
-
Endpoint used:
GET /auth/check
inherited
-
getLoggedUserDetailsResponse(String sessionToken)
→ Future<Response>
-
Endpoint used:
GET /user/me
inherited
-
getMangaAggregate(String mangaId, {List<String>? groupIds, List<LanguageCodes>? translatedLanguages})
→ Future<Aggregate>
-
Endpoint used:
GET /manga/{id}/aggregate
inherited
-
getMangaAggregateResponse(String mangaId, {List<String>? groupIds, List<LanguageCodes>? translatedLanguages})
→ Future<Response>
-
Endpoint used:
GET /manga/{id}/aggregate
inherited
-
getMangaDataByMangaId(String mangaId)
→ Future<SingleMangaData>
-
Endpoint used:
GET /manga/{id}
inherited
-
getMangaFeed(String mangaId, {int? limit, int? offset, List<LanguageCodes>? translatedLanguage, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguage, List<ContentRating>? contentRating, List<String>? excludedGroups, List<String>? excludedUploaders, bool? includeFutureUpdates, String? createdAtSince, String? updatedAtSince, String? publishAtSince, Map<ChapterOrders, OrderDirections>? order, List<String>? includes, bool? includeEmptyPages, bool? includeFuturePublishAt, bool? includeExternalUrl})
→ Future<MangaFeed>
-
Endpoint used:
GET /manga/{id}/feed
inherited
-
getMangaFeedResponse(String mangaId, {int? limit, int? offset, List<LanguageCodes>? translatedLanguage, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguage, List<ContentRating>? contentRating, List<String>? excludedGroups, List<String>? excludedUploaders, bool? includeFutureUpdates, String? createdAtSince, String? updatedAtSince, String? publishAtSince, Map<ChapterOrders, OrderDirections>? order, List<String>? includes, bool? includeEmptyPages, bool? includeFuturePublishAt, bool? includeExternalUrl})
→ Future<Response>
-
Endpoint used:
GET /manga/{id}/feed
inherited
-
getMangaReadingStatus(String sessionToken, String mangaId)
→ Future<MangaReadingStatus>
-
Endpoint used:
GET /manga/{id}/status
inherited
-
getRefreshResponse(String refreshToken)
→ Future<Response>
-
Endpoint used:
POST /auth/refresh
inherited
-
getScanlationGroup({int? limit, int? offset, List<String>? ids, String? name, LanguageCodes? focussedLanguage, List<String>? includes, Map<ScanlationOrders, OrderDirections>? order})
→ Future<ScanlationsResult>
-
Endpoint used:
GET /group
inherited
-
getScanlationGroupById(String groupId)
→ Future<Scanlation>
-
Endpoint used:
GET /group/{id}
inherited
-
getScanlationGroupByIdResponse(String groupId)
→ Future<Response>
-
Endpoint used:
GET /group/{id}
inherited
-
getScanlationGroupResponse({int? limit = 10, int? offset, List<String>? ids, String? name, LanguageCodes? focussedLanguage, List<String>? includes, Map<ScanlationOrders, OrderDirections>? order})
→ Future<Response>
-
Endpoint used:
GET /group
inherited
-
getSingleCustomList(String listId)
→ Future<SingleCustomListResponse>
-
Gets the data of the customList identified by it's
listId
or list uuid and returns a SingleCustomListResponse
containing the data.
inherited
-
getSingleCustomListResponse(String listId)
→ Future<Response>
-
Endpoint used:
GET /list/{id}/
inherited
-
getUserCustomLists(String userId, int? limit, int? offset)
→ Future<SingleCustomListResponse>
-
Endpoint used:
get /user/{id}/list
inherited
-
getUserCustomListsResponse(String userId, int? limit, int? offset)
→ Future<Response>
-
Endpoint used:
GET /user/{id}/list
inherited
-
getUserFeed(String sessionToken)
→ Future<UserFeed>
-
Endpoint used:
GET /user/follows/manga/feed
inherited
-
getUserFeedResponse(String sessionToken)
→ Future<Response>
-
Endpoint used:
GET /user/follows/manga/feed
inherited
-
getUserFollowedGroups(String sessionToken, int? offset, int? limit)
→ Future<UserFollowedGroups>
-
Endpoint used:
GET /user/follows/group
inherited
-
getUserFollowedGroupsResponse(String sessionToken, {int? offset, int? limit})
→ Future<Response>
-
Endpoint used:
GET /user/follows/group
inherited
-
getUserFollowedManga(String sessionToken, {int? offset, int? limit})
→ Future<UserFollowedManga>
-
Endpoint used:
GET /manga/{id}/aggregate
inherited
-
getUserFollowedMangaResponse(String sessionToken, {int? offset, int? limit})
→ Future<Response>
-
Endpoint used:
GET /user/follows/manga
inherited
-
getUserFollowedUsers(String sessionToken, {int? offset, int? limit})
→ Future<UserFollowedUsers>
-
Endpoint used:
GET /user/follows/user
inherited
-
getUserFollowedUsersResponse(String sessionToken, {int? offset, int? limit})
→ Future<Response>
-
Endpoint used:
GET /user/follows/user
inherited
-
login(String username, String password)
→ Future<Login>
-
Endpoint used:
POST /auth/login
-
logout(String sessionToken)
→ Future<Result>
-
Endpoint used:
POST /auth/logout
inherited
-
logoutResponse(String sessionToken)
→ Future<Response>
-
Endpoint used:
POST /auth/logout
inherited
-
markChapterRead(String sessionToken, String chapterId)
→ Future<Result>
-
Mark a chapter identified by it's
chapterId
or uuid as READ
DEPRECATION WARNING: The end point POST /chapter/{id}/read
is deprecated as is to be removed by 02-10-2022
Which makes this function deprecated and on schedule to be removed as well.
inherited
-
markChapterReadOrUnRead(String mangaId, String sessionToken, {List<String>? chapterIdsRead, List<String>? chapterIdsUnread})
→ Future<Result>
-
Marks a chapter of a manga identified by it's
mangaId
as read or unread
for user identified by their sessionToken
.
inherited
-
markChapterUnread(String sessionToken, String chapterId)
→ Future<Result>
-
Mark a chapter identified by it's
chapterId
or uuid as UNREAD
DEPRECATION WARNING: The end point DELETE /chapter/{id}/read
is deprecated as is to be removed by 2-10-2022
Which makes this function deprecated and on schedule to be removed as well.
inherited
-
markMultipleChaptersRead(String sessionToken, String mangaId, List<String> chapterIds)
→ Future<Result>
-
Marks multiple chapters in the list of
chapterIds
or uuids as READ
inherited
-
markMultipleChaptersUnread(String sessionToken, String mangaId, List<String> chapterIds)
→ Future<Result>
-
Marks multiple chapters in the list of
chapterIds
or uuids as UNREAD
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
refresh(String refreshToken)
→ Future<Login>
-
Endpoint used:
POST /auth/refresh
inherited
-
removeMangaFromCustomList(String sessionToken, String mangaId, String listId)
→ Future<Result>
-
Endpoint used:
DELETE /manga/{id}/list/{id}
inherited
-
removeMangaFromCustomListResponse(String sessionToken, String mangaId, String listId)
→ Future<Response>
-
Endpoint used:
DELETE /manga/{id}/list/{id}
inherited
-
removeMangaReadingStatus(String sessionToken, String mangaId)
→ Future<Result>
-
Endpoint used:
DELETE /manga/{id}/aggregate
inherited
-
search({String? query, int? limit, int? offset, List<String>? authors, List<String>? artists, int? year, List<String>? includedTags, TagsMode? includedTagsMode, List<String>? excludedTags, TagsMode? excludedTagsMode, List<MangaStatus>? status, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguages, List<LanguageCodes>? availableTranslatedLanguage, List<PublicDemographic>? publicationDemographic, List<String>? ids, List<ContentRating>? contentRating, String? createdAtSince, String? updatedAtSince, List<String>? includes, String? group, Map<SearchOrders, OrderDirections>? orders})
→ Future<Search>
-
Endpoint used:
GET /manga
inherited
-
searchAuthor(String? name, int? limit, int? offset, List<String>? ids, List<String>? includes)
→ Future<AuthorSearchResults>
-
Endpoint used:
GET /author/{id}
inherited
-
searchAuthorResponse(String? name, int? limit, int? offset, List<String>? ids, List<String>? includes)
→ Future<Response>
-
Endpoint used:
GET /author
inherited
-
searchResponse({String? title, int? limit, int? offset, List<String>? authors, List<String>? artists, int? year, List<String>? includedTags, TagsMode? includedTagsMode, List<String>? excludedTags, TagsMode? excludedTagsMode, List<MangaStatus>? status, List<LanguageCodes>? originalLanguage, List<LanguageCodes>? excludedOriginalLanguages, List<LanguageCodes>? availableTranslatedLanguage, List<PublicDemographic>? publicationDemographic, List<String>? ids, List<ContentRating>? contentRating, String? createdAtSince, String? updatedAtSince, List<String>? includes, String? group, Map<SearchOrders, OrderDirections>? orders, bool? hasAvailableChapters})
→ Future<Response>
-
Endpoint used:
GET /manga
inherited
-
setMangaReadingStatus(String sessionToken, String mangaId, ReadingStatus? status)
→ Future<Result>
-
Endpoint used:
POST /manga/{id}/status
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
unfollowCustomList(String sessionToken, String listId)
→ Future<Result>
-
Endpoint used:
DELETE /loist/{id}/follow
inherited
-
unfollowCustomListResponse(String sessionToken, String listId)
→ Future<Response>
-
Endpoint used:
DELETE /list/{id}/follow
inherited
-
unfollowManga(String sessionToken, String mangaId)
→ Future<Result>
-
Endpoint used:
DELETE /manga/{id}/aggregate
inherited
-
updateCustomList(String sessionToken, String listId, String listName, Visibility visibility, List<String> mangaIds, int version)
→ Future<SingleCustomListResponse>
-
Endpoint used:
PUT /manga/{id}/aggregate
inherited
-
updateCustomListResponse(String sessionToken, String listId, String listName, Visibility visibility, List<String> mangaIds, int version)
→ Future<Response>
-
Endpoint used:
PUT /list/{id}
inherited