Home Manual Reference Source Test Repository
import ChannelFinder from 'opengate-js/src/channels/ChannelFinder.js'
public class | source

ChannelFinder

Extends:

GenericFinderProvisionGenericFinder → ChannelFinder

This class allow make get request to channel resource into Opengate North API.

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

Performs a get that returns channels related

public

findByDomainAndWorkgroupAndOrganization(domain: string, workgroup: string, organization: string): Promise

Performs a get that returns channels related

public

Download a specific channel by its organization and id.

Public Constructors

public constructor(ogapi: InternalOpenGateAPI) source

Constructor

Override:

ProvisionGenericFinder#constructor

Params:

NameTypeAttributeDescription
ogapi InternalOpenGateAPI

Reference to the API object.

Public Methods

public findByDomainAndWorkgroup(domain: string, workgroup: string): Promise source

Performs a get that returns channels related

Params:

NameTypeAttributeDescription
domain string

domain

workgroup string

workgroup.

Return:

Promise

public findByDomainAndWorkgroupAndOrganization(domain: string, workgroup: string, organization: string): Promise source

Performs a get that returns channels related

Params:

NameTypeAttributeDescription
domain string

domain

workgroup string

workgroup.

organization string

organization.

Return:

Promise

public findByOrganizationAndName(organization: string, name: string): Promise source

Download a specific channel by its organization and id. This execute a GET http method

Params:

NameTypeAttributeDescription
organization string

channel organization .

name string

channel name.

Return:

Promise