SearchFilter class

Filter the results returns by the Holodex API channel endpoints

Annotations

• @Freezed(fromJson: false, toJson: true)

Constructors

SearchFilter({@JsonKey(name: 'sort', toJson: searchSortToString) @Default(SearchSort.newest) SearchSort sort, @JsonKey(toJson: languageListToStringList, name: 'lang') @Default([]) List<Language> languages, @Default([SearchTarget.clip, SearchTarget.stream]) @JsonKey(name: 'target', toJson: searchTargetToStringList) List<SearchTarget> targets, @JsonKey(name: 'topic') @Default([]) List<String> topics, @JsonKey(name: 'vch') @Default([]) List<String> videoChannels, @JsonKey(name: 'org', toJson: organizationListToStringList) @Default([]) List<Organization> organizations, @Default(true) bool paginated, @JsonKey(toJson: intToString) @Default(0) int offset, @JsonKey(toJson: intToString) @Default(25) int limit})

Filter the results returns by the Holodex API channel endpoints

const

factory

Properties

copyWith → $SearchFilterCopyWith<SearchFilter>

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

languages → List<Language>

If set, will filter clips to only show clips with these languages + all vtuber streams (provided searchTargets is not set to filter out streams)

no setter, inherited

limit → int

Result limit

no setter, inherited

offset → int

Offset results

no setter, inherited

organizations → List<Organization>

Videos of channels in any of the specified organizations, or clips that involve a channel in the specified organization.

no setter, inherited

paginated → bool

If paginated is set to true, returns List<VideoFull> with total, otherwise returns List<VideoFull> without the total.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sort → SearchSort

Sort by newest or oldest

no setter, inherited

targets → List<SearchTarget>

Target types of videos

no setter, inherited

topics → List<String>

Return videos that match one of the provided topics

no setter, inherited

videoChannels → List<String>

Videos with all of the specified channel ids. If two or more channel IDs are specified, will only return their collabs, or if one channel is a clipper, it will only show clips of the other vtubers made by this clipper.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited