Organizations Search Builder
OrganizationsSearchBuilder
OrganizationsSearchBuilder Objects
class OrganizationsSearchBuilder()Defined a search over organizations
constructor
function constructor()Arguments:
parentInternalOpenGateAPI - Instance of our InternalOpenGateAPI
build
function build() -> '*'Returns:
*
fluentFilter
function fluentFilter()tagsFilter
function tagsFilter()withChannelName
function withChannelName(channelName: string) -> 'OrganizationsSearchBuilder'Sets de organization name to search
Arguments:
channelNamestring - hardware id
Returns:
OrganizationsSearchBuilder
Example:
ogapi.organizationsSearchBuilder().withChannelName('myOrganization').build()withDomain
function withDomain(domainName: string) -> 'OrganizationsSearchBuilder'Sets de domain name to search
Arguments:
domainNamestring - domain name
Returns:
OrganizationsSearchBuilder
Example:
ogapi.organizationsSearchBuilder().withDomain('myDomain').build()withName
function withName(organizationName: string) -> 'OrganizationsSearchBuilder'Sets de organization name to search
Arguments:
organizationNamestring - hardware id
Returns:
OrganizationsSearchBuilder
Example:
ogapi.organizationsSearchBuilder().withName('myOrganization').build()withWorkgroup
function withWorkgroup(workgroupName: string) -> 'OrganizationsSearchBuilder'Sets de workgroup name to search
Arguments:
workgroupNamestring - workgroup name
Returns:
OrganizationsSearchBuilder
Example:
ogapi.organizationsSearchBuilder().withWorkgroup('myWorkgroup').build()