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

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