Class Listing

constructor

• new Listing(api: Api): Listing

• Parameters

  • api: Api

  Returns Listing

api

get

• get(
      type: null | string | string[],
      criteria: FormattedCriteria,
      projection: string[],
      sort?: Record<string, -1 | 1>,
      page?: number,
      limit?: number,
      atTime?: string,
      queryParams?: Record<string, unknown>,
  ): Promise<ApiResponse<ElementDataWrapper[]>>

• Parameters

  • type: null | string | string[]
  • criteria: FormattedCriteria
  • projection: string[]
  • Optionalsort: Record<string, -1 | 1>
  • page: number = 1
  • limit: number = 100
  • OptionalatTime: string
  • OptionalqueryParams: Record<string, unknown>

  Returns Promise<ApiResponse<ElementDataWrapper[]>>

getListingRequestHash

• getListingRequestHash(
      params: [
          type: null
          | string
          | string[],
          criteria: FormattedCriteria,
          projection: string[],
          sort?: Record<string, -1 | 1>,
          page?: number,
          limit?: number,
          atTime?: string,
          queryParams?: Record<string, unknown>,
      ],
      organization: string,
      context: DynamicContext,
  ): string

• Parameters

  • params: [
        type: null
        | string
        | string[],
        criteria: FormattedCriteria,
        projection: string[],
        sort?: Record<string, -1 | 1>,
        page?: number,
        limit?: number,
        atTime?: string,
        queryParams?: Record<string, unknown>,
    ]
  • organization: string
  • context: DynamicContext

  Returns string

loadAllElements

• loadAllElements(
      totalCount: number,
      criteria: FormattedCriteria,
      type: null | string | string[],
      projection: string[],
      options: IQueryOptions,
      onLoadCurrentPage?: (
          rows: ElementDataWrapper[],
          pagesToLeft?: number,
      ) => Promise<void>,
      queryParams?: Record<string, unknown>,
  ): Promise<ElementDataWrapper[]>

• Parameters

  • totalCount: number
  • criteria: FormattedCriteria
  • type: null | string | string[]
  • projection: string[]
  • options: IQueryOptions
  • OptionalonLoadCurrentPage: (rows: ElementDataWrapper[], pagesToLeft?: number) => Promise<void>
  • OptionalqueryParams: Record<string, unknown>

  Returns Promise<ElementDataWrapper[]>

parseCriteria

• parseCriteria(
      criteria: QueryCriteria,
      context?: DynamicContext,
      initial?: FormattedCriteria,
  ): FormattedCriteria

• Parameters

  • criteria: QueryCriteria
  • Optionalcontext: DynamicContext
  • initial: FormattedCriteria = {}

  Returns FormattedCriteria

parseDynamicFilter

• parseDynamicFilter(
      rawValue: unknown,
      context?: DynamicContext,
  ): FormattedCriterium

• Parameters

  • rawValue: unknown
  • Optionalcontext: DynamicContext

  Returns FormattedCriterium

StaticformatCriteria

• formatCriteria(criteria: IListingFilter[]): QueryCriteria | { $or?: any }

• Parameters

  • criteria: IListingFilter[]

  Returns QueryCriteria | { $or?: any }

StaticgetCriterionName

• getCriterionName(key: string): string

• Parameters

  • key: string

  Returns string

StaticgetDefaultLogicOperation

• getDefaultLogicOperation(
      attributeType: undefined | string,
  ): "EQUAL" | "CONTAINSWORD"

• Parameters

  • attributeType: undefined | string

  Returns "EQUAL" | "CONTAINSWORD"

StaticparsePresetConfig

• parsePresetConfig(preset: IListingPreset): IListingConfig

• Parameters

  • preset: IListingPreset

  Returns IListingConfig