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

public class | source

SubscribersSearchBuilder

Defined a search over Subscribers

ogapi.subscribersSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

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

From class FlattenedSearchBuilder
public	build(): Search Build a instance of Search
public	flattened(): FlattenedSearchBuilder The response will return a flattened response

From class PreFilteredSearchBuilder
public	collected(): PreFilteredSearchBuilder This option forces search api to add a filter of collected content
public	disableCaseSensitive(flag: *): EntitiesSearchBuilder The response will return a response by applying the filter with likes case-no-sensitive
public	disableDefaultSorted(): PreFilteredSearchBuilder The response will return a response without sorted
public	provisioned(): PreFilteredSearchBuilder This option forces search api to add a filter of provisioned content
public	removeCaseSensitive(): EntitiesSearchBuilder The response will return a response by applying the filter with likes case-no-sensitive
public	select(select: SelectBuilder \| object): PreFilteredSearchBuilder The search request will have this filter

Constructor

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