Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 6.37 KB

getsearchalllibrariesrequest.md

File metadata and controls

26 lines (21 loc) · 6.37 KB

GetSearchAllLibrariesRequest

Example Usage

import { GetSearchAllLibrariesRequest, SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";

let value: GetSearchAllLibrariesRequest = {
  query: "<value>",
  clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
  searchTypes: [
    SearchTypes.People,
  ],
};

Fields

Field Type Required Description Example
query string ✔️ The search query term.
clientID string ✔️ An opaque identifier unique to the client (UUID, serial number, or other unique device ID) 3381b62b-9ab7-4e37-827b-203e9809eb58
limit number ➖ Limit the number of results returned.
searchTypes operations.SearchTypes[] ➖ A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.
 movies,music,otherVideos,people,tv
includeCollections operations.GetSearchAllLibrariesQueryParamIncludeCollections ➖ Whether to include collections in the search results. 1
includeExternalMedia operations.GetSearchAllLibrariesQueryParamIncludeExternalMedia ➖ Whether to include external media in the search results. 1