shared/models/search/videos-common-query.model.ts

   1 import { VideoInclude } from '../videos/video-include.enum'
   2 import { BooleanBothQuery } from './boolean-both-query.model'
   3
   4 // These query parameters can be used with any endpoint that list videos
   5 export interface VideosCommonQuery {
   6   start?: number
   7   count?: number
   8   sort?: string
   9
  10   nsfw?: BooleanBothQuery
  11
  12   isLive?: boolean
  13
  14   // FIXME: deprecated in 4.0 in favour of isLocal and include, to remove
  15   filter?: never
  16
  17   isLocal?: boolean
  18   include?: VideoInclude
  19
  20   categoryOneOf?: number[]
  21
  22   licenceOneOf?: number[]
  23
  24   languageOneOf?: string[]
  25
  26   tagsOneOf?: string[]
  27   tagsAllOf?: string[]
  28
  29   hasHLSFiles?: boolean
  30   hasWebtorrentFiles?: boolean
  31
  32   skipCount?: boolean
  33
  34   search?: string
  35 }
  36
  37 export interface VideosCommonQueryAfterSanitize extends VideosCommonQuery {
  38   start: number
  39   count: number
  40   sort: string
  41
  42   // FIXME: deprecated in 4.0, to remove
  43   filter?: never
  44 }