import CertificatesSearchBuilder from 'opengate-js/src/searching/builder/CertificatesSearchBuilder.js'

public class | source

CertificatesSearchBuilder

SearchBuilder → CertificatesSearchBuilder

Defined a search over Bundles

ogapi.bundlesSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Public Methods
public	administrable(): CertificatesSearchBuilder The search result will have all certificates which can be administered by the user
public	assignable(): CertificatesSearchBuilder The search result will have all certificates which can be assignable to some device ogapi.certificatesSearchBuilder().assignable()
public	withFetch(flag: flag): CertificatesSearchBuilder Set fecth value

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

Constructor

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

The search result will have all certificates which can be administered by the user

 ogapi.certificatesSearchBuilder().administrable()

The search result will have all certificates which can be assignable to some device ogapi.certificatesSearchBuilder().assignable()

Set fecth value

Name	Type	Attribute	Description
flag	flag	nullable: false

throw error when flag is not a number

 ogapi.certificatesSearchBuilder().withFetch(true)