PixivApi class

Constructors

PixivApi()

Properties

accountGetter ↔ UserAccount? Function()
latefinal
accountUpdater ↔ void Function(UserAccount userAccount)
latefinal
auth ↔ PixivAuth
latefinal
deviceName ↔ String
latefinal
hashCode → int
The hash code for this object.
no setterinherited
languageGetter ↔ String Function()
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targetIPGetter ↔ String Function()
latefinal

Methods

addBookmark(int id, {List<String> tags = const [], Restrict restrict = Restrict.public, bool isNovel = false}) → Future<void>
收藏作品
id - 作品ID
tags - 标签(自己添加的)
isNovel - 小说
addComment(int illustId, {String comment = '', int? stampId, int? parentCommentId}) → Future<Comment>
添加评论(评论一个插画)
illustId - 插画ID
comment - 评论内容
stampId - 表情包ID
parentCommentId - 父评论ID(用来回复)
addFollow(int userId, {Restrict restrict = Restrict.public}) → Future<void>
关注用户
userId - 用户ID
restrict 为ture获取公开的(public) 反之不公开(private)
deleteBookmark(int id, {bool isNovel = false}) → Future<void>
取消收藏作品
id - 作品ID
isNovel 小说
deleteComment(int commentId) → Future<void>
删除评论(自己的)
commentId - 评论ID
deleteFollow(int userId) → Future<void>
取消关注用户
userId - 用户ID
getBookmarkTags(int userId, {Restrict restrict = Restrict.public, bool isNovel = false, required CancelToken cancelToken}) → Future<BookmarkTags>
获取收藏标签 userId - 用户ID isNovel - 小说
getCommentReplies(int commentId, {required CancelToken cancelToken}) → Future<Comments>
获取评论的回复
commentId - 评论ID
getFollower(int userId, {required CancelToken cancelToken}) → Future<Users>
获取粉丝
getFollowingUsers(int userId, {Restrict restrict = Restrict.public, required CancelToken cancelToken}) → Future<Users>
获取关注用户
userId - 用户ID
getFollowNewIllusts({required Restrict? restrict, required CancelToken cancelToken}) → Future<Illusts>
获取关注者的新插画
restrict - 为ture获取公开的(public) 反之不公开(private) null(全部)
getFollowNewNovels({required Restrict? restrict, required CancelToken cancelToken}) → Future<Novels>
获取关注者的新小说
restrict - 为ture获取公开的(public) 反之不公开(private) null(全部)
getIllustComments(int illustId, {required CancelToken cancelToken}) → Future<Comments>
获取插画的评论
illustId - 插画ID
getIllustDetail(int illustId, {required CancelToken cancelToken}) → Future<IllustDetail>
获取插画详细
如果没有查询到会返回404 : ErrorMessage.fromJson =>
illustId - 插画ID
getIllustRelated(int illustId, {required CancelToken cancelToken}) → Future<Illusts>
获取插画的相关推荐
illustId - 插画ID
getNewIllusts(IllustType type, {required CancelToken cancelToken}) → Future<Illusts>
获取最近发布的插画
type - 类型(IllustType) illust , manga
getNewNovels({required CancelToken cancelToken}) → Future<Novels>
获取最近发布的小说
getNovelHtml(int novelId, {required CancelToken cancelToken}) → Future<String>
获取小说HTML页面
novelId - 小说ID
getRanking(RankingMode mode, {required CancelToken cancelToken}) → Future<Illusts>
获取排行榜
mode - 方式(RankingMode)
getRecommendedIllusts(IllustType type, {required CancelToken cancelToken}) → Future<Illusts>
获取推荐插画
type - 类型(IllustType)
getRecommendedNovels({required CancelToken cancelToken}) → Future<Novels>
获取推荐小说
getRecommendedUsers({required CancelToken cancelToken}) → Future<Users>
获取推荐用户
getTrendingTags({required CancelToken cancelToken}) → Future<TrendingTags>
获取推荐标签(搜索用的)
getUgoiraMetadata(int illustId, {required CancelToken cancelToken}) → Future<UgoiraMetadata>
获取动图 illustId 插画ID
getUserDetail(int userId, {required CancelToken cancelToken}) → Future<UserDetail>
获取用户详细信息
如果没有查询到会返回404 : ErrorMessage.fromJson =>
userId - 用户ID
getUserIllustBookmarks(int userId, {Restrict restrict = Restrict.public, required CancelToken cancelToken}) → Future<Illusts>
获取用户收藏的插画
userId - 用户ID
getUserIllusts(int userId, IllustType type, {required CancelToken cancelToken}) → Future<Illusts>
获取用户的插画
userId - 用户ID
type - 类型(WorkType)
getUserNovelBookmarks(int userId, {Restrict restrict = Restrict.public, required CancelToken cancelToken}) → Future<Novels>
获取用户收藏的小说
userId - 用户ID
getUserNovels(int userId, {required CancelToken cancelToken}) → Future<Novels>
获取用户的小说
userId - 用户ID
init({required PixivAuth auth, required String targetIPGetter(), required String languageGetter(), required String deviceName, required UserAccount? accountGetter(), required void accountUpdater(UserAccount userAccount)}) → PixivApi
兼容GetX的GetxService
next<T>(String url, {required CancelToken cancelToken}) → Future<T>
下一页
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
searchAutocomplete(String word, {required CancelToken cancelToken}) → Future<SearchAutocomplete>
搜索的关键字自动补全
word - 关键字
searchIllust(String word, SearchSort sort, SearchTarget target, {String? startDate, String? endDate, int? bookmarkTotal, required CancelToken cancelToken}) → Future<SearchIllust>
搜索
word - 关键字
sort - 排序(SearchSort)
target - 搜索目标(SearchTarget)
startDate - 开始时间(必须跟endDate一起填)
endDate - 结束时间(必须跟startDate一起填)
bookmarkTotal - 收藏数量 100, 250, 500, 1000, 5000, 7500 , 10000, 20000, 30000, 50000
searchNovel(String word, SearchSort sort, SearchTarget target, {String? startDate, String? endDate, int? bookmarkTotal, required CancelToken cancelToken}) → Future<SearchNovel>
搜索
word - 关键字
sort - 排序(SearchSort)
target - 搜索目标(SearchTarget)
startDate - 开始时间(必须跟endDate一起填)
endDate - 结束时间(必须跟startDate一起填)
bookmarkTotal - 收藏数量 100, 250, 500, 1000, 5000, 7500, 10000, 20000, 30000, 50000
searchUsers(String word, {required CancelToken cancelToken}) → Future<Users>
搜索用户 word - 关键字
toString() → String
A string representation of this object.
inherited

Operators

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