ShadertoyHybridClient class

A Shadertoy hybrid client

An implementation of the ShadertoyWS and ShadertoySite APIs providing the full set of methods either through the ShadertoySite implementation or through the ShadertoyWS implementation then falling back to the ShadertoySite implementation. This could be used to provide the same set of shaders available through the REST API (public+api privacy settings) complementing those with additional methods available through the site implementation

Implemented types

Constructors

ShadertoyHybridClient(ShadertoySiteOptions siteOptions, {ShadertoyWSOptions? wsOptions, Dio? client})
Builds a ShadertoyHybridClient

Properties

context → ShadertoyContext
The ShadertoyContext object stores Shadertoy website contextual information
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
loggedIn → Future<bool>
Returns true when logged in, false otherwise
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

downloadMedia(String inputPath) → Future<DownloadFileResponse>
Returns a DownloadFileResponse for a path inputPath
override
downloadShaderPicture(String shaderId) → Future<DownloadFileResponse>
Returns a DownloadFileResponse for a shader with id shaderId
override
findAllShaderIds() → Future<FindShaderIdsResponse>
Returns a FindShaderIdsResponse with all the shader id's
findAllShaderIdsByPlaylistId(String playlistId) → Future<FindShaderIdsResponse>
Returns a FindShaderIdsResponse with all the shader id's for the playlist playlistId
findAllShaderIdsByUserId(String userId) → Future<FindShaderIdsResponse>
Returns a FindShaderIdsResponse with all the shader id's for the user userId
findCommentsByShaderId(String shaderId) → Future<FindCommentsResponse>
Returns a FindCommentsResponse for a shader with id shaderId
findNewShaderIds(Set<String> storeShaderIds) → Future<FindShaderIdsResponse>
Returns a new FindShaderIdsResponse with a list of the new shader ids.
override
findPlaylistById(String playlistId) → Future<FindPlaylistResponse>
Returns a FindPlaylistResponse for a playlist with playlistId
findShaderById(String shaderId) → Future<FindShaderResponse>
Returns a FindShaderResponse for the shader with shaderId
findShaderIds({String? term, Set<String>? filters, Sort? sort, int? from, int? num}) → Future<FindShaderIdsResponse>
Returns a filtered FindShaderIdsResponse with a list of shader ids.
findShaderIdsByPlaylistId(String playlistId, {int? from, int? num}) → Future<FindShaderIdsResponse>
Returns a FindShaderIdsResponse with a list of shader ids.
findShaderIdsByUserId(String userId, {Set<String>? filters, Sort? sort, int? from, int? num}) → Future<FindShaderIdsResponse>
Returns a filtered FindShaderIdsResponse with a list of shader ids. for the user userId
findShaders({String? term, Set<String>? filters, Sort? sort, int? from, int? num}) → Future<FindShadersResponse>
Returns a filtered FindShadersResponse with a list of shaders
findShadersByIdSet(Set<String> shaderIds) → Future<FindShadersResponse>
Returns a FindShadersResponse for each shader id in shaderIds
findShadersByPlaylistId(String playlistId, {int? from, int? num}) → Future<FindShadersResponse>
Returns a FindShadersResponse with a list of shaders. for the playlist playlistId
findShadersByUserId(String userId, {Set<String>? filters, Sort? sort, int? from, int? num}) → Future<FindShadersResponse>
Returns a filtered FindShadersResponse for user userId
findUserById(String userId) → Future<FindUserResponse>
Returns a FindUserResponse for user with userId
login() → Future<LoginResponse>
Performs a login in shadertoy website
override
logout() → Future<LogoutResponse>
Performs a logout in shadertoy website
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rsync(ShadertoyStore metadataStore, VaultStore assetStore, HybridSyncMode mode, {SyncTaskRunner? runner, int? concurrency, int? timeout, List<String> playlistIds = const <String>[]}) → Future<void>
Synchronizes the metadataStore with the remote shadertoy data.
override
toString() → String
A string representation of this object.
inherited

Operators

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