2023-03-03 04:47:08 +02:00
# openapi.api.SearchApi
## Load the API package
```dart
import 'package:openapi/api.dart';
```
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
2023-03-05 22:44:31 +02:00
[**getExploreData** ](SearchApi.md#getexploredata ) | **GET** /search/explore |
2023-03-03 04:47:08 +02:00
[**search** ](SearchApi.md#search ) | **GET** /search |
2023-10-10 16:34:25 +02:00
[**searchPerson** ](SearchApi.md#searchperson ) | **GET** /search/person |
2023-03-03 04:47:08 +02:00
2023-03-05 22:44:31 +02:00
# **getExploreData**
> List<SearchExploreResponseDto> getExploreData()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-03-05 22:44:31 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = SearchApi();
try {
final result = api_instance.getExploreData();
print(result);
} catch (e) {
print('Exception when calling SearchApi->getExploreData: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<SearchExploreResponseDto>** ](SearchExploreResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-03-05 22:44:31 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2023-03-03 04:47:08 +02:00
# **search**
2024-01-29 16:51:22 +02:00
> SearchResponseDto search(clip, motion, q, query, recent, smart, type, withArchived)
2023-03-03 04:47:08 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-03-03 04:47:08 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = SearchApi();
2024-01-29 16:51:22 +02:00
final clip = true; // bool | @deprecated
2024-01-22 18:49:51 +02:00
final motion = true; // bool |
2023-03-20 22:16:32 +02:00
final q = q_example; // String |
final query = query_example; // String |
final recent = true; // bool |
2024-01-29 16:51:22 +02:00
final smart = true; // bool |
2024-01-22 18:49:51 +02:00
final type = type_example; // String |
2024-01-18 04:08:00 +02:00
final withArchived = true; // bool |
2023-03-03 04:47:08 +02:00
try {
2024-01-29 16:51:22 +02:00
final result = api_instance.search(clip, motion, q, query, recent, smart, type, withArchived);
2023-03-03 04:47:08 +02:00
print(result);
} catch (e) {
print('Exception when calling SearchApi->search: $e\n');
}
```
### Parameters
2023-03-20 22:16:32 +02:00
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2024-01-29 16:51:22 +02:00
**clip** | **bool** | @deprecated | [optional]
2024-01-22 18:49:51 +02:00
**motion** | **bool** | | [optional]
2023-03-20 22:16:32 +02:00
**q** | **String** | | [optional]
**query** | **String** | | [optional]
**recent** | **bool** | | [optional]
2024-01-29 16:51:22 +02:00
**smart** | **bool** | | [optional]
2024-01-22 18:49:51 +02:00
**type** | **String** | | [optional]
2024-01-18 04:08:00 +02:00
**withArchived** | **bool** | | [optional]
2023-03-03 04:47:08 +02:00
### Return type
[**SearchResponseDto** ](SearchResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-03-03 04:47:08 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2023-10-10 16:34:25 +02:00
# **searchPerson**
2023-10-24 17:53:49 +02:00
> List<PersonResponseDto> searchPerson(name, withHidden)
2023-10-10 16:34:25 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = SearchApi();
final name = name_example; // String |
2023-10-24 17:53:49 +02:00
final withHidden = true; // bool |
2023-10-10 16:34:25 +02:00
try {
2023-10-24 17:53:49 +02:00
final result = api_instance.searchPerson(name, withHidden);
2023-10-10 16:34:25 +02:00
print(result);
} catch (e) {
print('Exception when calling SearchApi->searchPerson: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String** | |
2023-10-24 17:53:49 +02:00
**withHidden** | **bool** | | [optional]
2023-10-10 16:34:25 +02:00
### Return type
[**List<PersonResponseDto>** ](PersonResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)