Mguy13/mc_gallery
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs

Browse source
This commit is contained in:
Mguy13 2022-12-26 19:39:47 +01:00
parent 78fe9e7b09
commit c7324a6b19
458 changed files with 93141 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

376
doc/api/features_home_services_images_service/ImagesService-class.html Normal file
View file

@ -0,0 +1,376 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
<meta name="description" content="API docs for the ImagesService class from the images_service library, for the Dart programming language.">
<title>ImagesService class - images_service library - Dart API</title>
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link rel="stylesheet" href="../static-assets/github.css?v1">
<link rel="stylesheet" href="../static-assets/styles.css?v1">
<link rel="icon" href="../static-assets/favicon.png?v1">
</head>
<body data-base-href="../" data-using-base-href="false">
<div id="overlay-under-drawer"></div>
<header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="../index.html">mc_gallery</a></li>
<li><a href="../features_home_services_images_service/features_home_services_images_service-library.html">images_service</a></li>
<li class="self-crumb">ImagesService class</li>
</ol>
<div class="self-name">ImagesService</div>
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
<div>
<h1><span class="kind-class">ImagesService</span> class
<a href="https://dart.dev/null-safety" class="feature feature-null-safety" title="Supports the null safety language feature.">Null safety</a>
</h1></div>
<section class="desc markdown">
<p>Handles fetching and storing of Images.</p>
<p>Since this is very simple use-case, this is the only interface. For complex (actual CRUD-based) I/O,
an additional Repository layer interface can be used between <a href="../features_home_services_images_service/ImagesService-class.html">ImagesService</a> and <a href="../features_home_abstracts_images_api/ImagesApi-class.html">ImagesApi</a>.</p>
</section>
<section class="summary offset-anchor" id="constructors">
<h2>Constructors</h2>
<dl class="constructor-summary-list">
<dt id="ImagesService" class="callable">
<span class="name"><a href="../features_home_services_images_service/ImagesService/ImagesService.html">ImagesService</a></span><span class="signature">(<span class="parameter" id="-param-imagesApi">{<span>required</span> <span class="type-annotation"><a href="../features_home_abstracts_images_api/ImagesApi-class.html">ImagesApi</a></span> <span class="parameter-name">imagesApi</span>, </span><span class="parameter" id="-param-localStorageService"><span>required</span> <span class="type-annotation"><a href="../features_core_services_local_storage_service/LocalStorageService-class.html">LocalStorageService</a></span> <span class="parameter-name">localStorageService</span>, </span><span class="parameter" id="-param-loggingService"><span>required</span> <span class="type-annotation"><a href="../features_core_services_logging_service/LoggingService-class.html">LoggingService</a></span> <span class="parameter-name">loggingService</span>}</span>)</span>
</dt>
<dd>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="instance-properties">
<h2>Properties</h2>
<dl class="properties">
<dt id="firstAvailableImageIndex" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/firstAvailableImageIndex.html">firstAvailableImageIndex</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="hashCode" class="property inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
</dt>
<dd class="inherited">
The hash code for this object.
<div class="features">read-only, inherited</div>
</dd>
<dt id="imageModels" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/imageModels.html">imageModels</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Iterable-class.html">Iterable</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../features_home_data_models_image_model/ImageModel-class.html">ImageModel</a></span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="initAwaiter" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/initAwaiter.html">initAwaiter</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="lastAvailableImageIndex" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/lastAvailableImageIndex.html">lastAvailableImageIndex</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="lastQueryIsCompleted" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/lastQueryIsCompleted.html">lastQueryIsCompleted</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="numberOfImages" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/numberOfImages.html">numberOfImages</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="runtimeType" class="property inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
</dt>
<dd class="inherited">
A representation of the runtime type of the object.
<div class="features">read-only, inherited</div>
</dd>
</dl>
</section>
<section
class="summary offset-anchor"
id="instance-methods">
<h2>Methods</h2>
<dl class="callables">
<dt id="imageModelAt" class="callable">
<span class="name"><a href="../features_home_services_images_service/ImagesService/imageModelAt.html">imageModelAt</a></span><span class="signature">(<wbr><span class="parameter" id="imageModelAt-param-index">{<span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">index</span>}</span>)
<span class="returntype parameter">&#8594; <a href="../features_home_data_models_image_model/ImageModel-class.html">ImageModel</a></span>
</span>
</dt>
<dd>
</dd>
<dt id="noSuchMethod" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
<span class="returntype parameter">&#8594; dynamic</span>
</span>
</dt>
<dd class="inherited">
Invoked when a non-existent method or property is accessed.
<div class="features">inherited</div>
</dd>
<dt id="searchImages" class="callable">
<span class="name"><a href="../features_home_services_images_service/ImagesService/searchImages.html">searchImages</a></span><span class="signature">(<wbr><span class="parameter" id="searchImages-param-searchOption">{<span>required</span> <span class="type-annotation"><a href="../features_home_data_enums_search_option/SearchOption.html">SearchOption</a></span> <span class="parameter-name">searchOption</span>, </span><span class="parameter" id="searchImages-param-imageNamePart"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">imageNamePart</span>, </span><span class="parameter" id="searchImages-param-treatAsInSequence"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">treatAsInSequence</span> = <span class="default-value">false</span>}</span>)
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../features_home_data_models_image_model/ImageModel-class.html">ImageModel</a></span>&gt;</span></span>&gt;</span></span>
</span>
</dt>
<dd>
Performs searching on images, both locally and by a Web API endpoint.
</dd>
<dt id="toString" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
</span>
</dt>
<dd class="inherited">
A string representation of this object.
<div class="features">inherited</div>
</dd>
<dt id="updateImageFavouriteStatus" class="callable">
<span class="name"><a href="../features_home_services_images_service/ImagesService/updateImageFavouriteStatus.html">updateImageFavouriteStatus</a></span><span class="signature">(<wbr><span class="parameter" id="updateImageFavouriteStatus-param-imageModel">{<span>required</span> <span class="type-annotation"><a href="../features_home_data_models_image_model/ImageModel-class.html">ImageModel</a></span> <span class="parameter-name">imageModel</span>, </span><span class="parameter" id="updateImageFavouriteStatus-param-newFavouriteStatus"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">newFavouriteStatus</span>}</span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
</dd>
</dl>
</section>
<section
class="summary offset-anchor inherited"
id="operators">
<h2>Operators</h2>
<dl class="callables">
<dt id="operator ==" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
</span>
</dt>
<dd class="inherited">
The equality operator.
<div class="features">inherited</div>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="static-properties">
<h2>Static Properties</h2>
<dl class="properties">
<dt id="locate" class="property">
<span class="name"><a href="../features_home_services_images_service/ImagesService/locate.html">locate</a></span>
<span class="signature">&#8594; <a href="../features_home_services_images_service/ImagesService-class.html">ImagesService</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
</dl>
</section>
</div> <!-- /.main-content -->
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
<header id="header-search-sidebar" class="hidden-l">
<form class="search-sidebar" role="search">
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li><a href="../index.html">mc_gallery</a></li>
<li><a href="../features_home_services_images_service/features_home_services_images_service-library.html">images_service</a></li>
<li class="self-crumb">ImagesService class</li>
</ol>
<h5>images_service library</h5>
<ol>
<li class="section-title"><a href="../features_home_services_images_service/features_home_services_images_service-library.html#classes">Classes</a></li>
<li><a href="../features_home_services_images_service/ImagesService-class.html">ImagesService</a></li>
</ol>
</div>
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
<ol>
<li class="section-title"><a href="../features_home_services_images_service/ImagesService-class.html#constructors">Constructors</a></li>
<li><a href="../features_home_services_images_service/ImagesService/ImagesService.html">ImagesService</a></li>
<li class="section-title">
<a href="../features_home_services_images_service/ImagesService-class.html#instance-properties">Properties</a>
</li>
<li><a href="../features_home_services_images_service/ImagesService/firstAvailableImageIndex.html">firstAvailableImageIndex</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../features_home_services_images_service/ImagesService/imageModels.html">imageModels</a></li>
<li><a href="../features_home_services_images_service/ImagesService/initAwaiter.html">initAwaiter</a></li>
<li><a href="../features_home_services_images_service/ImagesService/lastAvailableImageIndex.html">lastAvailableImageIndex</a></li>
<li><a href="../features_home_services_images_service/ImagesService/lastQueryIsCompleted.html">lastQueryIsCompleted</a></li>
<li><a href="../features_home_services_images_service/ImagesService/numberOfImages.html">numberOfImages</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
<li class="section-title"><a href="../features_home_services_images_service/ImagesService-class.html#instance-methods">Methods</a></li>
<li><a href="../features_home_services_images_service/ImagesService/imageModelAt.html">imageModelAt</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li><a href="../features_home_services_images_service/ImagesService/searchImages.html">searchImages</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li><a href="../features_home_services_images_service/ImagesService/updateImageFavouriteStatus.html">updateImageFavouriteStatus</a></li>
<li class="section-title inherited"><a href="../features_home_services_images_service/ImagesService-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
<li class="section-title"><a href="../features_home_services_images_service/ImagesService-class.html#static-properties">Static properties</a></li>
<li><a href="../features_home_services_images_service/ImagesService/locate.html">locate</a></li>
</ol>
</div><!--/.sidebar-offcanvas-->
</main>
<footer>
<span class="no-break">
mc_gallery
1.0.0+1
</span>
</footer>
<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>
</body>
</html>