Sunbird Portal Documentation
  1. Interfaces
  2. SearchParam

File

src/app/modules/core/interfaces/search.ts

Description

Interface

Index

Properties

Properties

channel
channel: string
Type : string
Optional

page channel
concept
concept: Array<object>
Type : Array<object>
Optional

Content concept
contentType
contentType: string[]
Type : string[]
Optional

Content type - course,textbook,content
createdBy
createdBy: string
Type : string
Optional

createdBy id
exists
exists: Array<string>
Type : Array<string>
Optional
facets
facets: Array<string>
Type : Array<string>
Optional

facet filters
fields
fields: string[]
Type : string[]
Optional
filters
filters: any
Type : any
Optional

filters param
isRootOrg
isRootOrg: boolean
Type : boolean
Optional
limit
limit: number
Type : number
Optional

page limit
locationIds
locationIds: string[]
Type : string[]
Optional
mimeType
mimeType: Array<string>
Type : Array<string>
Optional

page mimeType
mode
mode: string
Type : string
Optional

mode : soft
objectType
objectType: string[]
Type : string[]
Optional

page objectType
offset
offset: number
Type : number
Optional

page offset
orgid
orgid: string[]
Type : string[]
Optional

Organization ids
pageNumber
pageNumber: number
Type : number
Optional
params
params: any
Type : any
Optional

Additional params - userId, lastUpdatedOn, sort etc
query
query: string
Type : string
Optional

page query
rootOrgId
rootOrgId: string[]
Type : string[]
Optional

rootOrgId ids
softConstraints
softConstraints: object
Type : object
Optional

filters badgeAssertions
sort_by
sort_by: literal type
Type : literal type
Optional

filters sort_by
status
status: string[]
Type : string[]
Optional

Content status

 
export interface SearchParam {

  /**
   * Content status
   */
  status?: string[];
  /**
   * Content type - course,textbook,content
   */
  contentType?: string[];
  /**
   * Content concept
   */
  concept?: Array<object>;
  /**
   * Additional params - userId, lastUpdatedOn, sort etc
   */
  params?: any;
  /**
   * createdBy id
   */
  createdBy?: string;
  /**
   * Organization ids
   */
  orgid?: string[];
  /**
   * rootOrgId ids
  */
  rootOrgId?: string[];
  /**
  * page limit
  */
  limit?: number;
  /**
   * page offset
   */
  offset?: number;

  pageNumber?: number;
  /**
   * page mimeType
   */
  mimeType?: Array<string>;
  /**
   * page query
   */
  query?: string;
  /**
   * page channel
   */
  channel?: string;
  /**
   * page objectType
   */
  objectType?: string[];
  /**
   * filters param
   */
  filters?: any;
  /**
  * filters sort_by
  */
  sort_by?: { [key: string]: string };
  /**
    * filters badgeAssertions
  */
  softConstraints?: object;
  /**
    * facet filters
  */
 facets?: Array<string>;
 exists?: Array<string>;
  /**
     * mode : soft
     */
 mode?: string;

 fields?: string[];
 locationIds?: string[];
 isRootOrg?: boolean;
}

results matching ""

    No results matching ""