dart_holodex_api library

Support for doing something awesome.

More dartdocs go here.

Classes

Channel
A Channel class with information retrieved from Holodex.
ChannelFilter
Filter the results returns by the Holodex API channel endpoints
ChannelMin
A ChannelMin class with information retrieved from Holodex.
ChannelVideoFilter
Filter the results returns by the Holodex API channel videos endpoints
Comment
A Comment class with information retrieved from Holodex.
HolodexClient
A client for the Holodex API.
Language
Holodex uses the BCP47 standard for language codes
Locale
A representation of a Unicode Locale Identifier.
Organization
Organizations supported by Holodex.
PaginatedVideos
A paginated list of VideoFulls.
Response
An HTTP response where the entire response body is known in advance.
SearchFilter
Filter the results returns by the Holodex API channel endpoints
Song
A Song class with information retrieved from Holodex.
Video
A Video class with information retrieved from Holodex.
VideoFilter
Filter the results returns by the Holodex API /videos endpoint
VideoFull
An extended Video class with comments, sources, refers, simulcasts, mentions, and songs fields.

Enums

ChannelSort
Options to sort a list of channels from the HolodexClient.getChannels endpoint.
ChannelType
The type of a channel.
HolodexEndpoint
Holodex API endpoints.
Includes
An enum which contains strings that allow extra data to be returned when requesting videos.
Order
An enum that allows a list to be sorted alphabetically
SearchSort
The sort order of a search.
SearchTarget
The types of videos to search for.
VideoSearchType
An enum that provides different search types when retrieving videos.
VideoSort
Options to sort a lsit of videos by
VideoStatus
The status of a video.
VideoType
The type of a video.

Mixins

EnumWithCode
Mixin for enums that have a code.

Extensions

EnumByCode on List<T>
Extension methods for enums that have a code.
LanguageValues on List<Language>
Extension methods for list of Language.
OrganizationValues on List<Organization>
Organizations supported by Holodex.

Exceptions / Errors

HolodexException
Exception thrown when an error occurs while making a request to the Holodex API.