Web Components
  1. Injectables
  2. FavouritesService

File

platform-components-ng/projects/platform-components-lib/src/lib/components/collection/service/favourites.service.ts

Description

Favourite service

Index

Methods

Constructor

constructor(http: HttpClient, notificationService: QppNotificationService, collectionService: CollectionBrowsingService, applicationConfigService: ApplicationConfigService, assetService: AssetService)
Parameters :
Name Type Optional
http HttpClient No
notificationService QppNotificationService No
collectionService CollectionBrowsingService No
applicationConfigService ApplicationConfigService No
assetService AssetService No

Methods

addfavourite
addfavourite(favouritesObj: any)

Add favourite

Parameters :
Name Type Optional Description
favouritesObj any No

Favourites object
Returns : Promise<any>

Promise
Async getAllFavourites
getAllFavourites(loadServerData?: boolean)

Get all saved queries.

Parameters :
Name Type Optional
loadServerData boolean Yes
Returns : Promise<Observable<any>>

Promise<Observable>
getFilteredAssetFavouriteEntities
getFilteredAssetFavouriteEntities(filterName: string, filterConditions?: QueryCondition[])

Get filtered asset favourite

Parameters :
Name Type Optional Description
filterName string No

Filter name
filterConditions QueryCondition[] Yes
Returns : Observable<Entity[]>

Observable<Entity[]>
getFilteredAssetFavourites
getFilteredAssetFavourites(filterName: string)

Get filtered asset favourites deprecated

Parameters :
Name Type Optional Description
filterName string No

Filter name
Returns : any

Observable
Async getQueryResultCount
getQueryResultCount(queryId: number)

Get query result count

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : Promise<Number>

Promise
ngOnDestroy
ngOnDestroy()

Component lifecycle hook

Returns : void

void
Async refreshEntity
refreshEntity(entity: Entity)

Refresh entity

Parameters :
Name Type Optional Description
entity Entity No

Entity
Returns : Promise<Entity>

Promise
Async refreshEntityData
refreshEntityData(entity: Entity)

Refresh entity data

Parameters :
Name Type Optional Description
entity Entity No

Entity
Returns : Promise<void | Entity>

Promise<void | Entity>
removeFavourite
removeFavourite(favouritesObj: any)

Remove favourite

Parameters :
Name Type Optional Description
favouritesObj any No

Favourites object
Returns : Promise<any>

Promise
Async removeFromLocalStore
removeFromLocalStore(favouritesObj: any)

Remove from local store

Parameters :
Name Type Optional Description
favouritesObj any No

Favourites object
Returns : any

void

result-matching ""

    No results matching ""