Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalQueryParams

Hierarchy

Index

Properties

categories

categories: (string | string[])[]

An array of categories stored within the item.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

extent

extent: Extent

Only relevant when querying for PortalItems.

Read more...

initialized

initialized: boolean

num

num: number

The maximum number of results to be included in the result set response.

Read more...

query

query: string

The query string used for the search.

Read more...

sortField

sortField: "created" | "type" | "title" | "uploaded" | "modified" | "username" | "owner" | "avg-rating" | "num-ratings" | "num-comments" | "num-views"

A comma-delimited list of fields to sort.

Read more...

sortOrder

sortOrder: "asc" | "desc"

The order in which to sort the results.

Read more...

start

start: number

The index of the first entry in the result set response.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalQueryParams

clone

  • Creates a deep clone of the instance of PortalQueryParams that calls this method.

    Read more...

    Returns PortalQueryParams

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalQueryParams

  • Parameters

    Returns PortalQueryParams

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc