Gelbooru

https://pub.dev/documentation/gelbooru/latest/
Admin
Gelbooru is a Dart package that provides a client library for interacting with Gelbooru-compatible...
Tokens:20,118
Snippets:304
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Add Gelbooru Package Dependency

Source: https://pub.dev/documentation/gelbooru/latest/index.html

Installs the gelbooru package and optionally the http and xml packages for exception handling.

```bash
# You may also add the http and xml packages for their respective exceptions
$ dart pub add gelbooru

```

--------------------------------

### Example of noSuchMethod Invocation

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson/noSuchMethod.html

Demonstrates how accessing a nonexistent method on a dynamic object triggers noSuchMethod. This code will result in a runtime error.

```dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error
```

--------------------------------

### single

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Get the single element from the current page, throws an error if not exactly one element.

```APIDOC
## single

### Description
Checks that this iterable has only one element, and returns that element.

### Property
`single` (T)

### Access
Read-only (inherited)
```

--------------------------------

### Get PID Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Pageable/pid.html

Represents an optional integer for the PID property. Use this to access the page identifier.

```dart
int? get pid;
```

--------------------------------

### length

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Get the number of objects in the current page of the response.

```APIDOC
## length

### Description
The number of objects in this list.

### Property
`length` (int)

### Access
Getter/Setter pair (inherited)
```

--------------------------------

### reversed

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Get an iterable of the elements in the current page in reverse order.

```APIDOC
## reversed

### Description
An Iterable of the objects in this list in reverse order.

### Property
`reversed` (Iterable<T>)

### Access
Read-only (inherited)
```

--------------------------------

### runtimeType Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Pageable/runtimeType.html

Gets a representation of the runtime type of the object.

```APIDOC
## runtimeType Property

### Description
A representation of the runtime type of the object.

### Type
Type get runtimeType

### Implementation
```dart
external Type get runtimeType;
```
```

--------------------------------

### iterator

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Get an iterator for the elements in the current page of the response.

```APIDOC
## iterator

### Description
A new `Iterator` that allows iterating the elements of this `Iterable`.

### Property
`iterator` (Iterator<T>)

### Access
Read-only (inherited)
```

--------------------------------

### Get Limit Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Limitable/limit.html

This snippet shows the declaration of the nullable integer 'limit' property. It can be used to set or retrieve a limit value.

```dart
int? get limit;
```

--------------------------------

### External int get hashCode

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson/hashCode.html

This is the external declaration for the hashCode property. It indicates that the implementation is provided externally, typically at the VM or platform level.

```dart
external int get hashCode;
```

--------------------------------

### Get xmlTag Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagDataAccessObject/xmlTag.html

This getter overrides the base implementation to return the string 'tag'. Use this when you need to access the XML tag representation of a tag.

```dart
@override
String get xmlTag => 'tag';
```

--------------------------------

### Get XML Tag for Comment

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/CommentDataAccessObject/xmlTag.html

Returns the XML tag 'comment' for the Comment Data Access Object. This is used to identify the comment element in XML structures.

```dart
@override
String get xmlTag => 'comment';
```

--------------------------------

### Fetch Posts from Gelbooru API

Source: https://pub.dev/documentation/gelbooru/latest/index.html

Demonstrates how to initialize the Gelbooru client and fetch posts with specific tags and a limit. The client is stateless and can be used as a singleton.

```dart
import 'package:gelbooru/gelbooru.dart';

Future<void> main() async {
  final GelbooruClient client = GelbooruClient();

  final PaginatedResponse<Post> posts = await client.posts.index(
    request: const PostIndexRequest(
      tags: <String?>['blonde', 'toys'],
      limit: 5,
    ),
  );

  for (final Post p in posts) {
    print(p.fileUrl);
  }
}

```

--------------------------------

### GelbooruClient Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/GelbooruClient.html

Creates a new instance of the GelbooruClient. You can optionally provide an existing http.Client or custom default headers.

```APIDOC
## GelbooruClient Constructor

### Description
Creates a new instance of the GelbooruClient. You can optionally provide an existing http.Client or custom default headers.

### Parameters
#### Named Parameters
- **client** (Client?) - Optional - An existing http.Client instance to use for requests.
- **defaultHeaders** (Map<String, String>?) - Optional - A map of default headers to include with all requests.
```

--------------------------------

### AutocompleteIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/AutocompleteIndexRequest/AutocompleteIndexRequest.html

Initializes a new instance of the AutocompleteIndexRequest class.

```APIDOC
## AutocompleteIndexRequest constructor

### Description
Creates a new AutocompleteIndexRequest with the specified term and an optional limit.

### Parameters
#### Named Parameters
- **term** (String) - Required - The search term for the autocomplete request.
- **limit** (int?) - Optional - The maximum number of results to return. Defaults to 10.
```

--------------------------------

### Create GelbooruClient with API Credentials

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/GelbooruClient.withApiCredentials.html

Use this factory constructor to create a GelbooruClient when you have API credentials. It requires a userId and apiKey, and throws an ArgumentError if either is empty.

```dart
factory GelbooruClient.withApiCredentials({
  //   required final String baseUrl,
  required final String userId,
  required final String apiKey,
  final Client? client,
  final Map<String, String>? defaultHeaders,
}) {
  if (userId.isEmpty || apiKey.isEmpty) {
    throw ArgumentError('userId and apiKey must not be empty');
  }

  return GelbooruClient._(
    //    baseUrl: baseUrl,
    client: client,
    defaultHeaders: defaultHeaders,
    defaultQueryParameters: <String, String>{
      'user_id': userId,
      'api_key': apiKey,
    },
  );
}
```

--------------------------------

### UserIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserIndexRequest-class.html

Initializes a new UserIndexRequest with optional parameters for filtering and pagination.

```APIDOC
## UserIndexRequest Constructor

### Description
Constructs a UserIndexRequest object with optional parameters.

### Parameters
- **cid** (String?): Optional. Filter by CID.
- **id** (String?): Optional. Filter by ID.
- **pid** (int?): Optional. Filter by PID.
- **limit** (int?): Optional. The maximum number of results to return. Defaults to 100.
- **tags** (List<String?>?): Optional. A list of tags to filter by.
- **json** (bool?): Optional. Whether to return results in JSON format. Defaults to false.
```

--------------------------------

### index

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserDataAccessObject-class.html

Fetches and parses a paginated list of users.

```APIDOC
## index

### Description
Fetches and parses a paginated list of `User` objects.

### Method
index

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (IndexRequest) - Required - The request object for indexing users.
```

--------------------------------

### Get isLocked Status

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/isLocked.html

This getter determines if a post is locked based on the postLocked value. It returns true if postLocked is 1 or null.

```dart
bool get isLocked => postLocked == 1 || postLocked == null;
```

--------------------------------

### GelbooruClient Constructors

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient-class.html

Constructors for creating an instance of GelbooruClient.

```APIDOC
## GelbooruClient()

### Description
Creates a GelbooruClient.

### Method
factory

### Parameters
- **client** (Client?) - Optional - An instance of the http.Client to use for requests.
- **defaultHeaders** (Map<String, String>?) - Optional - Default headers to include in all requests.
```

```APIDOC
## GelbooruClient.withApiCredentials()

### Description
Creates a GelbooruClient with API credentials.

### Method
factory

### Parameters
- **userId** (String) - Required - The user ID for API authentication.
- **apiKey** (String) - Required - The API key for authentication.
- **client** (Client?) - Optional - An instance of the http.Client to use for requests.
- **defaultHeaders** (Map<String, String>?) - Optional - Default headers to include in all requests.
```

--------------------------------

### take

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Creates a lazy iterable of the first 'count' elements.

```APIDOC
## take(int count)

### Description
Creates a lazy iterable of the `count` first elements of this iterable.

### Parameters
#### Path Parameters
- **count** (int) - Required - The number of elements to take from the beginning.

### Returns
- **Iterable<T>** - A lazy iterable containing the first `count` elements.
```

--------------------------------

### AutocompleteIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/AutocompleteIndexRequest-class.html

Initializes a new instance of the AutocompleteIndexRequest class. The 'term' parameter is required for the search query, and 'limit' can be optionally set to control the number of results.

```APIDOC
## AutocompleteIndexRequest Constructor

### Description
Initializes a new instance of the AutocompleteIndexRequest class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **term** (String) - Required - The search term for autocompletion.
- **limit** (int?) - Optional - The maximum number of results to return. Defaults to 10.
```

--------------------------------

### PostIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest-class.html

Initializes a new instance of the PostIndexRequest class with optional parameters for filtering and pagination.

```APIDOC
## PostIndexRequest Constructor

### Description
Constructs a PostIndexRequest object with optional parameters.

### Parameters
- **cid** (String?): Optional. Filter by CID.
- **id** (String?): Optional. Filter by ID.
- **pid** (int?): Optional. Filter by post ID.
- **limit** (int?): Optional. The maximum number of results to return. Defaults to 100.
- **tags** (List<String?>?): Optional. A list of tags to filter posts by.
- **json** (bool?): Optional. Whether to return results in JSON format. Defaults to false.
```

--------------------------------

### Get User Active Status

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/User/isActive.html

Returns true if the user's active status is 1, false otherwise. This is a simple getter implementation.

```dart
bool get isActive => active == 1;
```

--------------------------------

### GelbooruClient.withApiCredentials

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/GelbooruClient.withApiCredentials.html

Factory constructor to create a GelbooruClient instance with API credentials. It ensures that the userId and apiKey are not empty before proceeding.

```APIDOC
## GelbooruClient.withApiCredentials constructor

### Description
Creates a GelbooruClient with API credentials.

### Parameters
- **userId** (String) - Required - The user ID for authentication.
- **apiKey** (String) - Required - The API key for authentication.
- **client** (Client?) - Optional - An optional HTTP client to use.
- **defaultHeaders** (Map<String, String>?) - Optional - Default headers to include in requests.

### Implementation
```dart
factory GelbooruClient.withApiCredentials({
  required final String userId,
  required final String apiKey,
  final Client? client,
  final Map<String, String>? defaultHeaders,
}) {
  if (userId.isEmpty || apiKey.isEmpty) {
    throw ArgumentError('userId and apiKey must not be empty');
  }

  return GelbooruClient._(
    client: client,
    defaultHeaders: defaultHeaders,
    defaultQueryParameters: <String, String>{
      'user_id': userId,
      'api_key': apiKey,
    },
  );
}
```
```

--------------------------------

### Get xmlTag Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableXml/xmlTag.html

This property returns the XML tag as a String. It is a fundamental part of identifying and working with XML elements in the IndexableXml system.

```dart
String get xmlTag;
```

--------------------------------

### index method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson/index.html

Fetches and parses a paginated list of items of type T.

```APIDOC
## index method

### Description
Fetches and parses a paginated list of `T`.

### Method Signature
`Future<Iterable<T>> index({ required covariant IndexRequest request })`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
// Example usage requires an instance of IndexRequest and a configured client.
// final indexRequest = IndexRequest(...);
// final result = await gelbooruApi.index(request: indexRequest);
```

### Response
#### Success Response (200)
Returns an iterable of type `T`.

#### Response Example
```json
// Example response body would be a JSON array of objects, each representing an item of type T.
// [ { "field1": "value1", "field2": "value2" }, ... ]
```

### Error Handling
Throws `GelbooruException` if the status code is not 200.
```

--------------------------------

### Declare Sample Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/sample.html

Declares the 'sample' property as an optional integer. This is used to store the sample of a post.

```dart
final int? sample;
```

--------------------------------

### Implement toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/AutocompleteIndexRequest/toQueryParameters.html

This method overrides the superclass implementation to include specific parameters for tag queries. Use this to generate query parameters for autocomplete requests.

```dart
@override
Map<String, String> toQueryParameters() => <String, String>{
  ...super.toQueryParameters(),
  'term': term,
  'type': 'tag_query',
  'limit': limit.toString(),
};
```

--------------------------------

### Declare sampleWidth Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/sampleWidth.html

This snippet shows the declaration of the sampleWidth property as an integer.

```java
final int sampleWidth;
```

--------------------------------

### Get Runtime Type

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson/runtimeType.html

Use the runtimeType getter to obtain the Type object representing the runtime type of an object. This is an external getter, meaning its implementation is provided by the Dart VM.

```dart
external Type get runtimeType;
```

--------------------------------

### GelbooruClient Factory Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/GelbooruClient.html

Use this factory constructor to create a new GelbooruClient instance. It allows for optional configuration of the underlying HTTP client and default headers.

```dart
factory GelbooruClient({
  //  required final String baseUrl,
  final Client? client,
  final Map<String, String>? defaultHeaders,
}) => GelbooruClient._(
  //    baseUrl: baseUrl,
  client: client,
  defaultHeaders: defaultHeaders,
);
```

--------------------------------

### Declare afterId Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest/afterId.html

This snippet shows the declaration of the nullable String property 'afterId' within a Dart class. It is typically used to specify a starting point for tag index requests.

```dart
final String? afterId;

```

--------------------------------

### IndexRequest Class Methods

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexRequest-class.html

This section details the methods available on the IndexRequest class, including `toQueryParameters`, `hashCode`, `runtimeType`, `toString`, and `noSuchMethod`.

```APIDOC
## Methods

### toQueryParameters()

Converts the request parameters into a map of strings.

#### Returns
- Map<String, String>: A map representing the query parameters.
```

```APIDOC
### hashCode

Returns the hash code for this object.

#### Returns
- int: The hash code.
```

```APIDOC
### runtimeType

A representation of the runtime type of the object.

#### Returns
- Type: The runtime type.
```

```APIDOC
### toString()

A string representation of this object.

#### Returns
- String: The string representation.
```

```APIDOC
### noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

#### Parameters
- **invocation** (Invocation) - Required - The invocation details.

#### Returns
- dynamic: The result of the invocation.
```

--------------------------------

### Implement Index Method for Paginated Responses

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableXml/index.html

Fetches and parses a paginated list of `T` from an XML source. Handles HTTP requests, error checking, and XML parsing to return a `PaginatedResponse`. Ensure `IndexRequest` is provided and the client is configured.

```dart
Future<PaginatedResponse<T>> index({
  /// HTTP request parameters.
  required covariant final IndexRequest request,
}) async {
  final Uri uri = Uri.parse(_baseUrl).replace(
    queryParameters: request.toQueryParameters()
      ..addAll(_defaultQueryParameters),
  );
  final Response response = await _client.get(uri, headers: _defaultHeaders);

  if (response.statusCode != 200) {
    throw GelbooruException.fromResponse(response);
  }

  if (response.body.isEmpty) {
    return PaginatedResponse<T>.empty();
  }

  final XmlDocument document = XmlDocument.parse(response.body);
  final XmlElement root = document.rootElement;

  final int? limit = int.tryParse(root.getAttribute('limit') ?? '');
  final int? offset = int.tryParse(root.getAttribute('offset') ?? '');
  final int? count = int.tryParse(root.getAttribute('count') ?? '');

  final Iterable<T> data = root.findElements(xmlTag).map(_fromXml);

  return PaginatedResponse<T>._(
    source: UnmodifiableListView<T>(data),
    offset: offset,
    limit: limit,
    count: count,
  );
}
```

--------------------------------

### TagIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest-class.html

Initializes a new instance of the TagIndexRequest class with optional parameters for filtering and pagination.

```APIDOC
## TagIndexRequest Constructor

### Description
Initializes a new instance of the TagIndexRequest class.

### Parameters
- **id** (String?) - Optional - The ID for filtering.
- **pid** (int?) - Optional - The page ID for pagination.
- **limit** (int?) - Optional - The maximum number of results to return (defaults to 100).
- **afterId** (String?) - Optional - Filter results after a specific ID.
- **name** (String?) - Optional - Filter by tag name.
- **namePattern** (String?) - Optional - Filter by tag name pattern.
- **order** (Order?) - Optional - The order of the results.
- **orderBy** (OrderBy?) - Optional - The field to order the results by.
- **json** (bool?) - Optional - Whether to return results in JSON format (defaults to false).
```

--------------------------------

### Declare sampleHeight Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/sampleHeight.html

This snippet shows the declaration of the sampleHeight property as a final integer.

```java
final int sampleHeight;
```

--------------------------------

### Declare sampleUrl Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/sampleUrl.html

Declares the sampleUrl property as a final Uri. This property holds the URL of the sample image.

```dart
final Uri sampleUrl;
```

--------------------------------

### GelbooruClient Methods

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient-class.html

Methods available on the GelbooruClient class.

```APIDOC
## `toString()` → String

### Description
A string representation of this object.

### Method
`inherited`
```

```APIDOC
## `noSuchMethod(Invocation invocation)` → dynamic

### Description
Invoked when a nonexistent method or property is accessed.

### Method
`inherited`
```

--------------------------------

### toList

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Creates a List containing all elements of the iterable.

```APIDOC
## toList({bool growable = true})

### Description
Creates a List containing the elements of this Iterable.

### Parameters
#### Query Parameters
- **growable** (bool) - Optional - If true, the list is growable. Defaults to true.

### Returns
- **List<T>** - A list containing all elements from the iterable.
```

--------------------------------

### UserIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserIndexRequest/UserIndexRequest.html

The UserIndexRequest constructor allows you to initialize a request with various parameters such as content ID, user ID, post ID, limit, and tags.

```APIDOC
## UserIndexRequest constructor

### Description
Initializes a new instance of the UserIndexRequest class.

### Parameters
- **cid** (String?) - Optional - Content ID.
- **id** (String?) - Optional - User ID.
- **pid** (int?) - Optional - Post ID.
- **limit** (int?) - Optional - The maximum number of results to return. Defaults to 100.
- **tags** (List<String?>?) - Optional - A list of tags to filter the results by.
- **json** (bool?) - Optional - Whether to return the response in JSON format. Defaults to false.
```

--------------------------------

### index

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostDataAccessObject-class.html

Fetches and parses a paginated list of posts. This method is inherited from the DataAccessObject class.

```APIDOC
## index

### Description
Fetches and parses a paginated list of `Post` objects.

### Method Signature
`index({required covariant IndexRequest request}) → Future<PaginatedResponse<Post>>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
// Example usage (assuming IndexRequest and PostDataAccessObject are defined)
// final postDao = PostDataAccessObject();
// final request = IndexRequest(/* parameters */);
// final response = await postDao.index(request: request);
```

### Response
#### Success Response
- `Future<PaginatedResponse<Post>>`: A future that resolves to a `PaginatedResponse` containing a list of `Post` objects.
```

--------------------------------

### Limitable Mixin Methods

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Limitable-mixin.html

This section details the methods available on the Limitable mixin.

```APIDOC
## Methods

noSuchMethod(Invocation invocation) → dynamic
     Invoked when a nonexistent method or property is accessed.
     inherited 

toQueryParameters() → Map<String, String>
    
inherited 

tostring() → String
     A string representation of this object.
     inherited
```

--------------------------------

### CommentIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/CommentIndexRequest/CommentIndexRequest.html

Initializes a new instance of the CommentIndexRequest class.

```APIDOC
## CommentIndexRequest.new

### Description
Creates a new CommentIndexRequest with a required postId.

### Parameters
#### Path Parameters
- **postId** (String) - Required - The ID of the post to index comments for.
```

--------------------------------

### CommentIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/CommentIndexRequest-class.html

Initializes a new instance of the CommentIndexRequest class.

```APIDOC
## CommentIndexRequest({required String postId})

### Description
Constructs a CommentIndexRequest with the specified post ID.

### Parameters
#### Path Parameters
- **postId** (String) - Required - The id number of the comment to retrieve.
```

--------------------------------

### toString

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Returns a string representation of the object.

```APIDOC
## toString()

### Description
A string representation of this object.

### Returns
- **String** - The string representation of the object.
```

--------------------------------

### first

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Access the first element of the paginated response.

```APIDOC
## first

### Description
The first element.

### Property
`first` (T)

### Access
Getter/Setter pair (inherited)
```

--------------------------------

### TagIndexRequest Constructor Implementation

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest/TagIndexRequest.html

Provides the implementation for the TagIndexRequest constructor, initializing its properties and calling the superclass constructor.

```dart
const TagIndexRequest({
  this.id,
  this.pid,
  this.limit = 100,
  this.afterId,
  this.name,
  this.namePattern,
  this.order,
  this.orderBy,
  super.json,
}) : super._();
```

--------------------------------

### index method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableXml/index.html

Fetches and parses a paginated list of items. This method takes an IndexRequest object to specify query parameters and returns a PaginatedResponse.

```APIDOC
## index method

### Description
Fetches and parses a paginated list of `T`.

### Method Signature
`Future<PaginatedResponse<T>> index({ required covariant IndexRequest request })`

### Parameters
#### Path Parameters
None

#### Query Parameters
This method uses parameters defined within the `IndexRequest` object, which are converted to query parameters.

#### Request Body
None

### Request Example
```dart
// Assuming IndexRequest and _client are defined elsewhere
final indexRequest = IndexRequest(..., limit: 100, offset: 0);
final paginatedResponse = await gelbooruApi.index(request: indexRequest);
```

### Response
#### Success Response (200)
Returns a `PaginatedResponse<T>` containing a list of items, offset, limit, and total count.

- **source** (List<T>) - The list of items fetched.
- **offset** (int?) - The offset used for pagination.
- **limit** (int?) - The limit used for pagination.
- **count** (int?) - The total number of items available.

#### Response Example
```json
{
  "source": [
    // ... items of type T ...
  ],
  "offset": 0,
  "limit": 100,
  "count": 1500
}
```

### Error Handling
Throws a `GelbooruException` if the HTTP status code is not 200.
```

--------------------------------

### Declare previewHeight Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/previewHeight.html

This snippet shows the declaration of the final integer previewHeight property.

```java
final int previewHeight;

```

--------------------------------

### index

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableXml-mixin.html

Fetches and parses a paginated list of items of type T.

```APIDOC
## index

### Description
Fetches and parses a paginated list of `T`.

### Method
index

### Parameters
#### Path Parameters
- **request** (IndexRequest) - Required - The request object containing parameters for fetching data.
```

--------------------------------

### PostIndexRequest Constructor Definition

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest/PostIndexRequest.html

Defines the parameters for creating a PostIndexRequest. Supports optional parameters for filtering and pagination.

```dart
const PostIndexRequest({
  1. String? cid,
  2. String? id,
  3. int? pid,
  4. int? limit = 100,
  5. List<String?>? tags,
  6. bool? json = false,

})
```

--------------------------------

### IndexRequest Class Properties

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexRequest-class.html

This section outlines the properties of the IndexRequest class, including `hashCode`, `json`, and `runtimeType`.

```APIDOC
## Properties

### hashCode → int

The hash code for this object.

#### Returns
- int: The hash code.
```

```APIDOC
### json → bool?

Indicates if JSON serialization is supported or applicable.

#### Returns
- bool?: A boolean value, possibly null.
```

```APIDOC
### runtimeType → Type

A representation of the runtime type of the object.

#### Returns
- Type: The runtime type.
```

--------------------------------

### index

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson-mixin.html

Fetches and parses a paginated list of T, where T is a Model. This method requires an IndexRequest object.

```APIDOC
## index

### Description
Fetches and parses a paginated list of `T`.

### Method
index

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (IndexRequest) - Required - An object conforming to the IndexRequest interface.

### Request Example
```dart
// Assuming 'yourDataAccessObject' is an instance of a class that uses IndexableJson mixin
final request = IndexRequest(params: {...}); // Construct your IndexRequest
final results = await yourDataAccessObject.index(request: request);
```

### Response
#### Success Response (Iterable<T>)
- **Iterable<T>** - A collection of objects of type T.

#### Response Example
```json
[
  { "field1": "value1", "field2": "value2" },
  { "field1": "value3", "field2": "value4" }
]
```
```

--------------------------------

### Declare previewUrl Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/previewUrl.html

This snippet shows the declaration of the previewUrl property as a Uri type.

```dart
final Uri previewUrl;
```

--------------------------------

### PostDataAccessObject Initialization

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/posts.html

Initializes the posts property as a late final PostDataAccessObject. This allows access to the API methods for posts.

```dart
late final PostDataAccessObject posts;
```

--------------------------------

### TagIndexRequest Constructor Definition

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest/TagIndexRequest.html

Defines the parameters available for creating a TagIndexRequest. Includes optional parameters for filtering and pagination.

```dart
const TagIndexRequest({
  1. String? id,
  2. int? pid,
  3. int? limit = 100,
  4. String? afterId,
  5. String? name,
  6. String? namePattern,
  7. Order? order,
  8. OrderBy? orderBy,
  9. bool? json = false,

})
```

--------------------------------

### Declare previewWidth Property

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/previewWidth.html

This snippet shows the declaration of the final integer previewWidth property.

```dart
final int previewWidth;
```

--------------------------------

### PaginatedResponse.empty()

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse/PaginatedResponse.empty.html

Creates an empty PaginatedResponse with zero limit, offset, and count, and an unmodifiable empty list as the source.

```APIDOC
## PaginatedResponse.empty()

### Description
Creates an instance of PaginatedResponse with default empty values.

### Method
Factory Constructor

### Endpoint
N/A (Constructor)

### Parameters
None

### Request Body
None

### Response
#### Success Response
- **PaginatedResponse<T>** - An empty PaginatedResponse object.

### Response Example
```dart
PaginatedResponse<SomeModel>.empty()
```

### Implementation Details
```dart
factory PaginatedResponse.empty() => PaginatedResponse<T>._(
  limit: 0,
  offset: 0,
  count: 0,
  source: UnmodifiableListView<T>(<T>[]),
);
```
```

--------------------------------

### PostIndexRequest Constructor Implementation

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest/PostIndexRequest.html

The Dart implementation of the PostIndexRequest constructor, initializing its properties and calling the superclass constructor.

```dart
const PostIndexRequest({
  this.cid,
  this.id,
  this.pid,
  this.limit = 100,
  this.tags,
  super.json,
}) : super._();
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexRequest/toQueryParameters.html

This method converts the object's properties into a map of query parameters suitable for API requests. The default implementation specifically handles the 'json' parameter.

```APIDOC
## toQueryParameters Method

### Description
Converts object properties into a map of query parameters for API requests. The default implementation includes a 'json' parameter.

### Method Signature
`Map<String, String> toQueryParameters()`

### Implementation Details
- The method is marked with `@mustBeOverridden`, indicating it's intended to be implemented by subclasses.
- It generates a map containing a single entry: `'json': (json != null && json! ? 1 : 0).toString()`.
- This means if the `json` property is true, the value will be '1'; otherwise, it will be '0'.

### Example Usage (Conceptual)
```dart
// Assuming 'json' is a boolean property of the class
Map<String, String> params = instance.toQueryParameters();
// params might be {'json': '1'} or {'json': '0'}
```
```

--------------------------------

### Implement toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexRequest/toQueryParameters.html

This implementation converts the 'json' parameter to a query string. It sets 'json' to '1' if the 'json' property is not null and true, otherwise '0'.

```dart
@mustBeOverridden
Map<String, String> toQueryParameters() => <String, String>{
  'json': (json != null && json! ? 1 : 0).toString(),
};
```

--------------------------------

### Define Gelbooru API Base URL

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/GelbooruClient/baseUrl.html

Sets the base URL for the Gelbooru API. Use this to configure the client.

```dart
final String baseUrl = 'https://gelbooru.com';
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserIndexRequest/toQueryParameters.html

Converts the UserIndexRequest object into a map of query parameters. It includes parameters like 'cid', 'id', 'pid', 'limit', and 'tags', with specific handling for null values and tag formatting. The 'limit' parameter is clamped between 1 and 100.

```APIDOC
## toQueryParameters Method

### Description
Converts the UserIndexRequest object into a map of query parameters. It includes parameters like 'cid', 'id', 'pid', 'limit', and 'tags', with specific handling for null values and tag formatting. The 'limit' parameter is clamped between 1 and 100.

### Method Signature
Map<String, String> toQueryParameters()

### Implementation Details
- If `cid` is not null, it is included as 'cid'.
- If `id` is not null, it is included as 'id'.
- If `pid` is not null, it is converted to a string and included as 'pid'.
- If `limit` is not null, it is clamped between 1 and 100 and included as 'limit'.
- If `tags` is not null and not empty, they are joined with spaces and included as 'tags'.
- All parameters from the superclass are also included.
```

--------------------------------

### operator []

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Retrieves the element at the specified index.

```APIDOC
## operator []

### Description
Returns the object at the given `index` in the list.

### Method
operator []

### Parameters
- **index** (int) - The index of the element to retrieve.

### Returns
- **T** - The element at the specified index.
```

--------------------------------

### UserIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserIndexRequest/UserIndexRequest.html

Defines the UserIndexRequest constructor with optional parameters for filtering and pagination. The implementation initializes these parameters and calls the superclass constructor.

```dart
const UserIndexRequest({
  this.cid,
  this.id,
  this.pid,
  this.limit = 100,
  this.tags,
  super.json,
}) : super._();
```

--------------------------------

### CommentIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/CommentIndexRequest/CommentIndexRequest.html

Initializes a new instance of the CommentIndexRequest class. Requires a postId to be provided.

```dart
const CommentIndexRequest({required this.postId}) : super._();
```

--------------------------------

### isEmpty

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Check if the current page of the response is empty.

```APIDOC
## isEmpty

### Description
Whether this collection has no elements.

### Property
`isEmpty` (bool)

### Access
Read-only (inherited)
```

--------------------------------

### limit

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

The maximum number of elements per response page.

```APIDOC
## limit

### Description
Max elements of the response.

### Property
`limit` (int?)

### Access
Read-only
```

--------------------------------

### offset

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

The offset of the resources in the current response.

```APIDOC
## offset

### Description
The offset of the resources.

### Property
`offset` (int?)

### Access
Read-only
```

--------------------------------

### takeWhile

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Creates a lazy iterable of leading elements that satisfy a condition.

```APIDOC
## takeWhile(bool test(T element))

### Description
Creates a lazy iterable of the leading elements satisfying `test`.

### Parameters
#### Path Parameters
- **test** (bool(T element)) - Required - A function that returns true for elements to be included.

### Returns
- **Iterable<T>** - A lazy iterable containing leading elements that satisfy the test.
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/UserIndexRequest-class.html

Converts the UserIndexRequest object into a map of query parameters suitable for API requests.

```APIDOC
## toQueryParameters Method

### Description
Converts the UserIndexRequest object into a map of query parameters.

### Returns
- **Map<String, String>**: A map representing the query parameters.
```

--------------------------------

### Limitable Mixin Properties

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Limitable-mixin.html

This section details the properties available on the Limitable mixin.

```APIDOC
## Properties

hashCode → int
     The hash code for this object.
     no setterinherited 

json → bool?
    
finalinherited 

limit → int?
    
no setter 

runtimeType → Type
     A representation of the runtime type of the object.
     no setterinherited
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest-class.html

Converts the PostIndexRequest object into a map of query parameters suitable for API requests.

```APIDOC
## toQueryParameters Method

### Description
Converts the PostIndexRequest object into a map of query parameters.

### Returns
- **Map<String, String>**: A map where keys are parameter names and values are their string representations.
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Pageable/toQueryParameters.html

The `toQueryParameters` method is an abstract method that must be overridden by implementing classes. It is responsible for generating a map of query parameters from the object's state, typically for use in API requests. The default implementation handles the `json` property.

```APIDOC
## toQueryParameters Method

### Description
Converts object properties into a map of query parameters.

### Method Signature
`Map<String, String> toQueryParameters()`

### Implementation Details
This method is intended to be overridden. The provided implementation converts a nullable `json` boolean property into a string representation ('1' for true, '0' for false) if `json` is not null, otherwise it defaults to '0'.

```dart
@mustBeOverridden
Map<String, String> toQueryParameters() => <String, String>{
  'json': (json != null && json! ? 1 : 0).toString(),
};
```
```

--------------------------------

### count

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

The total number of resources available in the response.

```APIDOC
## count

### Description
The total number of resources.

### Property
`count` (int?)

### Access
Read-only
```

--------------------------------

### TagIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest/TagIndexRequest.html

The TagIndexRequest constructor allows for the creation of tag index requests with various optional parameters to filter and sort the results.

```APIDOC
## TagIndexRequest constructor

### Description
Initializes a new instance of the TagIndexRequest class.

### Parameters
#### Constructor Parameters
- **id** (String?) - Optional - The ID of the tag.
- **pid** (int?) - Optional - The page number.
- **limit** (int?) - Optional - The maximum number of results to return. Defaults to 100.
- **afterId** (String?) - Optional - The ID to fetch results after.
- **name** (String?) - Optional - The name of the tag.
- **namePattern** (String?) - Optional - A pattern to match tag names against.
- **order** (Order?) - Optional - The order of the results.
- **orderBy** (OrderBy?) - Optional - The field to order the results by.
- **json** (bool?) - Optional - Whether to return results in JSON format. Defaults to false.
```

--------------------------------

### operator +

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Returns the concatenation of this list and another list.

```APIDOC
## operator +

### Description
Returns the concatenation of this list and `other`.

### Method
operator +

### Parameters
- **other** (List<T>) - The list to concatenate with.

### Returns
- **List<T>** - A new list containing elements from both lists.
```

--------------------------------

### toSet

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Creates a Set containing the elements of the iterable.

```APIDOC
## toSet()

### Description
Creates a Set containing the same elements as this iterable.

### Returns
- **Set<T>** - A set containing the unique elements from the iterable.
```

--------------------------------

### PostIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest/PostIndexRequest.html

The PostIndexRequest constructor allows you to create a request object with various filtering and pagination parameters.

```APIDOC
## PostIndexRequest.new

### Description
Creates a new PostIndexRequest with optional parameters for filtering and pagination.

### Parameters
#### Constructor Parameters
- **cid** (String?) - Optional - The content ID to filter by.
- **id** (String?) - Optional - The ID to filter by.
- **pid** (int?) - Optional - The post ID to filter by.
- **limit** (int?) - Optional - The maximum number of results to return. Defaults to 100.
- **tags** (List<String?>?) - Optional - A list of tags to filter the posts.
- **json** (bool?) - Optional - Whether to return the results in JSON format. Defaults to false.
```

--------------------------------

### PaginatedResponse.empty Factory Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse/PaginatedResponse.empty.html

Use this factory constructor to create an instance of PaginatedResponse representing an empty result set. It initializes limit, offset, and count to zero, and provides an unmodifiable empty list as the source.

```dart
factory PaginatedResponse.empty() => PaginatedResponse<T>._(
  limit: 0,
  offset: 0,
  count: 0,
  source: UnmodifiableListView<T>(<T>[]),
);
```

--------------------------------

### PaginatedResponse.empty()

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Factory constructor to create an empty PaginatedResponse.

```APIDOC
## PaginatedResponse.empty()

### Description
Factory constructor to create an empty PaginatedResponse.

### Method
factory

### Endpoint
N/A (Constructor)
```

--------------------------------

### where

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Creates a lazy iterable with elements that satisfy a predicate.

```APIDOC
## where(bool test(T element))

### Description
Creates a new lazy Iterable with all elements that satisfy the predicate `test`.

### Parameters
#### Path Parameters
- **test** (bool(T element)) - Required - A function that returns true for elements to be included.

### Returns
- **Iterable<T>** - A lazy iterable containing elements that satisfy the test.
```

--------------------------------

### sublist

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Returns a new list containing elements within a specified range.

```APIDOC
## sublist(int start, [int? end])

### Description
Returns a new list containing the elements between `start` and `end`.

### Parameters
#### Path Parameters
- **start** (int) - Required - The starting index of the sublist.
- **end** (int) - Optional - The ending index of the sublist.

### Returns
- **List<T>** - A new list containing the specified elements.
```

--------------------------------

### Implement Index Method for Paginated Fetching

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/IndexableJson/index.html

Fetches and parses a paginated list of items. Handles HTTP requests, error checking, and JSON decoding. Returns an empty iterable if the response body is empty.

```dart
Future<Iterable<T>> index({
  /// HTTP request parameters.
  required covariant final IndexRequest request,
}) async {
  final Uri uri = Uri.parse(_baseUrl).replace(
    queryParameters: request.toQueryParameters()
      ..addAll(_defaultQueryParameters),
  );
  final Response response = await _client.get(uri, headers: _defaultHeaders);

  if (response.statusCode != 200) {
    throw GelbooruException.fromResponse(response);
  }

  if (response.body.isEmpty) {
    return Iterable<T>.empty();
  }

  final List<dynamic> data = json.decode(response.body);

  return data.cast<Map<String, dynamic>>().map(_fromJson);
}
```

--------------------------------

### Post Source Property Declaration

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/source.html

Declares the 'source' property as an optional string within the Post class.

```dart
final String? source;
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/CommentIndexRequest/toQueryParameters.html

The `toQueryParameters` method is an override that converts the object's properties into a `Map<String, String>` suitable for use as URL query parameters. It includes parameters from the superclass and adds the `postId`.

```APIDOC
## toQueryParameters Method

### Description
Converts the request object's properties into a map of query parameters.

### Method Signature
`Map<String, String> toQueryParameters()`

### Implementation Details
This method overrides the superclass's `toQueryParameters` method. It first includes all parameters from the superclass using the spread operator (`...super.toQueryParameters()`) and then adds the `postId` property to the map.

### Code Example
```dart
@override
Map<String, String> toQueryParameters() => <String, String>{
  ...super.toQueryParameters(),
  'post_id': postId,
};
```

### Parameters
This method does not take any explicit parameters.

### Returns
A `Map<String, String>` representing the query parameters for the request.
```

--------------------------------

### Directory Property Declaration

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/directory.html

This snippet shows the declaration of the 'directory' property, which is a nullable String.

```dart
final String? directory;
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PostIndexRequest/toQueryParameters.html

Converts the PostIndexRequest object's properties into a map suitable for API query parameters. It includes optional parameters like 'cid', 'id', 'pid', 'limit', and 'tags'.

```APIDOC
## toQueryParameters Method

### Description
Converts the PostIndexRequest object's properties into a map suitable for API query parameters. It includes optional parameters like 'cid', 'id', 'pid', 'limit', and 'tags'.

### Method Signature
Map<String, String> toQueryParameters()

### Implementation Details
- Inherits and overrides the superclass method.
- Conditionally includes parameters if they are not null or empty:
  - `cid`: If `cid` is not null, adds 'cid' to the map.
  - `id`: If `id` is not null, adds 'id' to the map.
  - `pid`: If `pid` is not null, converts it to a string and adds 'pid' to the map.
  - `limit`: If `limit` is not null, clamps its value between 1 and 100, converts it to a string, and adds 'limit' to the map.
  - `tags`: If `tags` is not null and not empty, joins the tags with spaces and adds 'tags' to the map.

### Example Usage (Conceptual)
```dart
// Assuming 'request' is an instance of PostIndexRequest
Map<String, String> queryParams = request.toQueryParameters();
// queryParams might look like: {'tags': 'cat dog', 'limit': '50'}
```
```

--------------------------------

### toQueryParameters method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/TagIndexRequest/toQueryParameters.html

Converts the TagIndexRequest object into a map of query parameters. It includes parameters like id, pid, limit, afterId, namePattern, name, order, and orderBy if they are not null. The limit parameter is clamped between 1 and 100.

```APIDOC
## toQueryParameters()

### Description
Converts the TagIndexRequest object into a map of query parameters.

### Method Signature
Map<String, String> toQueryParameters()

### Query Parameters Generated
- **id** (String) - Optional - The ID of the tag.
- **pid** (String) - Optional - The page ID.
- **limit** (String) - Optional - The maximum number of results to return (clamped between 1 and 100).
- **after_id** (String) - Optional - Returns results after the specified ID.
- **name_pattern** (String) - Optional - A pattern to match tag names against.
- **name** (String) - Optional - The exact name of the tag.
- **order** (String) - Optional - The order of the results.
- **orderby** (String) - Optional - The field to order the results by.
```

--------------------------------

### AutocompleteIndexRequest Constructor

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/AutocompleteIndexRequest/AutocompleteIndexRequest.html

Defines the constructor for AutocompleteIndexRequest, requiring a 'term' and optionally accepting a 'limit'. The limit defaults to 10.

```dart
const AutocompleteIndexRequest({
  1. required String term,
  2. int? limit = 10,

})
```

```dart
const AutocompleteIndexRequest({required this.term, this.limit = 10})
  : super._();
```

--------------------------------

### Limitable Mixin Operators

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Limitable-mixin.html

This section details the operators available on the Limitable mixin.

```APIDOC
## Operators

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

--------------------------------

### isNotEmpty

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/PaginatedResponse-class.html

Check if the current page of the response is not empty.

```APIDOC
## isNotEmpty

### Description
Whether this collection has at least one element.

### Property
`isNotEmpty` (bool)

### Access
Read-only (inherited)
```

--------------------------------

### Declare Final Integer Width

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/Post/width.html

This snippet shows the declaration of the final integer `width` property. Use this to define the image width.

```java
final int width;
```

--------------------------------

### toQueryParameters Method

Source: https://pub.dev/documentation/gelbooru/latest/gelbooru/AutocompleteIndexRequest-class.html

Overrides the base method to convert the AutocompleteIndexRequest object into a map of query parameters suitable for API requests.

```APIDOC
## toQueryParameters Method

### Description
Converts the AutocompleteIndexRequest object into a map of query parameters.

### Method
Override

### Parameters
None

### Returns
- **Map<String, String>** - A map representing the query parameters.
```
Tokens:
Raw