HolodexClient class Null safety

Constructors

HolodexClient({required String apiKey, String basePath = 'https://holodex.net/api/v2', Client? httpClient})
Creates a new instance of HolodexClient [...]

Properties

apiKey String
Your API key
final
basePath String
Base API URL
final
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

close() → void
Closes the client and cleans up any resources associated with it. [...]
get({String path = '', Map<String, String>? headers, Map<String, dynamic>? params}) Future<Response>
Utility method to make http get call
getChannelFromId(String channelId) Future<Channel>
Get a channel by its ID [...]
getChannels({List<Language>? lang, int limit = 25, int offset = 0, Order order = Order.ascending, Organization? organization, List<ChannelSort> sort = const [ChannelSort.organization]}) Future<List<Channel>>
Get channels [...]
getChannelVideos(String channelId, {List<Includes>? includes, List<Language> lang = const [Language.all], int limit = 25, int offset = 0, bool paginated = true}) Future<VideoFullList>
Get Videos From Channel [...]
getLiveVideos({String? channelId, List<Includes> includes = const [Includes.liveInfo], List<Language> lang = const [Language.all], int limit = 9999, int? maxUpcomingHours = 48, String? mentionedChannelId, int offset = 0, Order order = Order.ascending, List<Organization>? organization, bool paginated = true, List<VideoSort> sort = const <VideoSort>[VideoSort.availableAt], List<VideoStatus>? status = const [VideoStatus.live, VideoStatus.upcoming], String? topic, VideoType? type = VideoType.stream}) Future<VideoFullList>
Get a list of live videos [...]
getLiveVideosFromChannelsQuickly(List<String> channelIds) Future<List<Video>>
Quickly Access Live / Upcoming for a set of Channels [...]
getVideoFromId(String videoId, {List<Includes>? includes}) Future<VideoFull>
Get a video by its video ID [...]
getVideoMetadata(String videoId, {bool timestampComments = false, List<Language>? recommendationLanguages}) Future<VideoMetadata>
Retrieves a video [...]
getVideos({String? channelId, List<Includes>? includes, List<Language> lang = const [Language.all], int limit = 25, int? maxUpcomingHours, String? mentionedChannelId, int offset = 0, Order order = Order.descending, List<Organization>? organization, bool paginated = false, List<VideoSort> sort = const <VideoSort>[VideoSort.availableAt], List<VideoStatus>? status, String? topicId, VideoType? type}) Future<VideoFullList>
Get a list of videos [...]
getVideosRelatedToChannel(String channelId, {required VideoSearchType type, List<Includes>? includes, List<Language> lang = const [Language.all], int limit = 25, int offset = 0, bool paginated = true}) Future<VideoFullList>
Get Videos Related To Channel [...]
getVTuberClips(String channelId, {List<Includes>? includes, List<Language> lang = const [Language.all], int limit = 25, int offset = 0, bool paginated = true}) Future<VideoFullList>
Get Clips of a VTuber [...]
getVTuberCollabs(String channelId, {List<Includes>? includes, List<Language> lang = const [Language.all], int limit = 25, int offset = 0, bool paginated = true}) Future<VideoFullList>
Get Collabs that mention a VTuber [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
post({String path = '', Map<String, String>? headers, Map<String, dynamic>? params, Map<String, dynamic>? data}) Future<Response>
Utility method to make http post call
searchComments({SearchSort searchSort = SearchSort.newest, List<Language>? languages, List<SearchTarget>? searchTargets, required String comment, List<String>? topics, List<String>? vch, List<Organization>? organizations, bool paginated = true, int offset = 0, int limit = 25}) Future<VideoWithCommentsList>
Flexible endpoint to search for comments in videos fufilling multiple conditions. [...]
searchVideos({SearchSort searchSort = SearchSort.newest, List<Language>? languages, List<SearchTarget>? searchTargets, List<String>? conditions, List<String>? topics, List<String>? vch, List<Organization>? organizations, bool paginated = true, int offset = 0, int limit = 25}) Future<VideoFullList>
Flexible endpoint to search for videos fufilling multiple conditions. [...]
toString() String
A string representation of this object. [...]
inherited

Operators

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