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

public class | source

OrganizationsSearchBuilder

Extends:

SearchBuilder → OrganizationsSearchBuilder

Defined a search over organizations

Example:

ogapi.organizationsSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Member Summary

Public Members
public	fluentFilter: *
public	tagsFilter: *[]

Method Summary

Public Methods
public	build(): *
public	withChannelName(channelName: string): OrganizationsSearchBuilder Sets de organization name to search
public	withDomain(domainName: string): OrganizationsSearchBuilder Sets de domain name to search
public	withName(organizationName: string): OrganizationsSearchBuilder Sets de organization name to search
public	withWorkgroup(workgroupName: string): OrganizationsSearchBuilder Sets de workgroup name to search

Inherited Summary

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

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

SearchBuilder#constructor

Params:

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

Public Members

public fluentFilter: * source

public tagsFilter: *[] source

Public Methods

public build(): * source

Build a instance of Search

Override:

SearchBuilder#build

Return:

public withChannelName(channelName: string): OrganizationsSearchBuilder source

Sets de organization name to search

Params:

Name	Type	Attribute	Description
channelName	string	nullable: false	hardware id

Return:

OrganizationsSearchBuilder

Throw:

Error

throw error when channelName is not typeof string

Example:

 ogapi.organizationsSearchBuilder().withChannelName('myOrganization').build()

public withDomain(domainName: string): OrganizationsSearchBuilder source

Sets de domain name to search

Params:

Name	Type	Attribute	Description
domainName	string	nullable: false	domain name

Return:

OrganizationsSearchBuilder

Throw:

Error

throw error when domainName is not typeof string

Example:

 ogapi.organizationsSearchBuilder().withDomain('myDomain').build()

public withName(organizationName: string): OrganizationsSearchBuilder source

Sets de organization name to search

Params:

Name	Type	Attribute	Description
organizationName	string	nullable: false	hardware id

Return:

OrganizationsSearchBuilder

Throw:

Error

throw error when organizationName is not typeof string

Example:

 ogapi.organizationsSearchBuilder().withName('myOrganization').build()

public withWorkgroup(workgroupName: string): OrganizationsSearchBuilder source

Sets de workgroup name to search

Params:

Name	Type	Attribute	Description
workgroupName	string	nullable: false	workgroup name

Return:

OrganizationsSearchBuilder

Throw:

Error

throw error when workgroupName is not typeof string

Example:

 ogapi.organizationsSearchBuilder().withWorkgroup('myWorkgroup').build()