All URIs are relative to http://localhost:8686
| Method | HTTP request | Description |
|---|---|---|
| DeleteQueue | Delete /api/v1/queue/{id} | |
| DeleteQueueBulk | Delete /api/v1/queue/bulk | |
| GetQueue | Get /api/v1/queue |
DeleteQueue(ctx, id).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).Execute()
package main
import (
"context"
"fmt"
"os"
lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)
func main() {
id := int32(56) // int32 |
removeFromClient := true // bool | (optional) (default to true)
blocklist := true // bool | (optional) (default to false)
skipRedownload := true // bool | (optional) (default to false)
changeCategory := true // bool | (optional) (default to false)
configuration := lidarrClient.NewConfiguration()
apiClient := lidarrClient.NewAPIClient(configuration)
r, err := apiClient.QueueAPI.DeleteQueue(context.Background(), id).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.DeleteQueue``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiDeleteQueueRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
removeFromClient | bool | | [default to true] blocklist | bool | | [default to false] skipRedownload | bool | | [default to false] changeCategory | bool | | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteQueueBulk(ctx).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).QueueBulkResource(queueBulkResource).Execute()
package main
import (
"context"
"fmt"
"os"
lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)
func main() {
removeFromClient := true // bool | (optional) (default to true)
blocklist := true // bool | (optional) (default to false)
skipRedownload := true // bool | (optional) (default to false)
changeCategory := true // bool | (optional) (default to false)
queueBulkResource := *lidarrClient.NewQueueBulkResource() // QueueBulkResource | (optional)
configuration := lidarrClient.NewConfiguration()
apiClient := lidarrClient.NewAPIClient(configuration)
r, err := apiClient.QueueAPI.DeleteQueueBulk(context.Background()).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).QueueBulkResource(queueBulkResource).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.DeleteQueueBulk``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiDeleteQueueBulkRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| removeFromClient | bool | [default to true] | |
| blocklist | bool | [default to false] | |
| skipRedownload | bool | [default to false] | |
| changeCategory | bool | [default to false] | |
| queueBulkResource | QueueBulkResource |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResourcePagingResource GetQueue(ctx).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeUnknownArtistItems(includeUnknownArtistItems).IncludeArtist(includeArtist).IncludeAlbum(includeAlbum).ArtistIds(artistIds).Protocol(protocol).Quality(quality).Execute()
package main
import (
"context"
"fmt"
"os"
lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)
func main() {
page := int32(56) // int32 | (optional) (default to 1)
pageSize := int32(56) // int32 | (optional) (default to 10)
sortKey := "sortKey_example" // string | (optional)
sortDirection := lidarrClient.SortDirection("default") // SortDirection | (optional)
includeUnknownArtistItems := true // bool | (optional) (default to false)
includeArtist := true // bool | (optional) (default to false)
includeAlbum := true // bool | (optional) (default to false)
artistIds := []int32{int32(123)} // []int32 | (optional)
protocol := lidarrClient.DownloadProtocol("unknown") // DownloadProtocol | (optional)
quality := []int32{int32(123)} // []int32 | (optional)
configuration := lidarrClient.NewConfiguration()
apiClient := lidarrClient.NewAPIClient(configuration)
resp, r, err := apiClient.QueueAPI.GetQueue(context.Background()).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeUnknownArtistItems(includeUnknownArtistItems).IncludeArtist(includeArtist).IncludeAlbum(includeAlbum).ArtistIds(artistIds).Protocol(protocol).Quality(quality).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.GetQueue``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetQueue`: QueueResourcePagingResource
fmt.Fprintf(os.Stdout, "Response from `QueueAPI.GetQueue`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetQueueRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | [default to 1] | |
| pageSize | int32 | [default to 10] | |
| sortKey | string | ||
| sortDirection | SortDirection | ||
| includeUnknownArtistItems | bool | [default to false] | |
| includeArtist | bool | [default to false] | |
| includeAlbum | bool | [default to false] | |
| artistIds | []int32 | ||
| protocol | DownloadProtocol | ||
| quality | []int32 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]