Skip to main content

CollectionBroker

Properties

(Mandatory properties are in bold)
PropertiesTypeDescription
addFilteraddFilter(filterOrCriteria: QueryFilterOrCriteria,parentFilterId: QueryFilterId,subscriberId: string): void
addFilterCriteriaaddFilterCriteria(field: string,operator: QueryFilterCriteriaOperator,value: QueryFilterCriteriaValue | QueryFilterCriteriaValue[],not: boolean,id: QueryFilterId,parentFilterId: QueryFilterId,subscriberId: string): void
addSortByaddSortBy(sortBy: QuerySortBy,prepend: boolean): void
addSubscriberaddSubscriber(id: string,subscriber: C): void
clearFieldsclearFields(subscriberId: string): void
clearFilterclearFilter(subscriberId: string): void
clearParamclearParam(key: string,subscriberId: string): void
clearParamsclearParams(subscriberId: string): void
clearSearchclearSearch(subscriberId: string): void
clearSortclearSort(subscriberId: string): void
clearSortByclearSortBy(subscriberId: string): void
filterfilter(filter: null | QueryFilter | QueryFilterCriteria | QueryFilterOrCriteria[],subscriberId: string): void
getInitialDataSourcegetInitialDataSource(subscriberId: string): undefined | string | T[]
getInitialQuerygetInitialQuery(subscriberId: string): Query
removeFilterremoveFilter(filterId: QueryFilterId,subscriberId: string): void
removeSortByremoveSortBy(id: string,subscriberId: string): void
removeSubscriberremoveSubscriber(id: string): void
searchsearch(search: Primitive,subscriberId: string): void
setDatasetData(data: T[],query: Query,subscriberId: string): void
setFieldssetFields(fields: string[],subscriberId: string): void
setParamsetParam(key: string,value: any,subscriberId: string): void
setParamssetParams(params: AnonymousObject<any>,subscriberId: string): void
setUrlsetUrl(url: string,query: Query,subscriberId: string): void
sortsort(dir: QuerySortDir,subscriberId: string): void
sortBysortBy(sortBy: string | QuerySortBy | QuerySortBy[],subscriberId: string): void