Subsections of channels

Channel Finder

This class allows making GET requests to the channel resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByDomainAndWorkgroup(domain, workgroup)

Performs a GET request that returns the channels related to the given domain and workgroup.

Parámetros

Nombre Tipo Opcional Descripción
domain string ❌ domain
workgroup string ❌ workgroup.

Retorna

Tip

Tipo: Promise

findByDomainAndWorkgroupAndOrganization(domain, workgroup, organization)

Performs a GET request that returns the channels related to the given domain, workgroup, and organization.

Parámetros

Nombre Tipo Opcional Descripción
domain string ❌ domain
workgroup string ❌ workgroup.
organization string ❌ organization.

Retorna

Tip

Tipo: Promise

findByOrganizationAndName(organization, name)

Downloads a specific channel by its organization and name. This executes a GET HTTP method.

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ channel organization .
name string ❌ channel name.

Retorna

Tip

Tipo: Promise

Channels

This is a base object that contains everything you can do with a channel.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withCertificate(certificate)

Set the certificate attribute

Parámetros

Nombre Tipo Opcional Descripción
certificate string ❌

Retorna

Tip

Tipo: Channels

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Channels

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Channels

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌

Retorna

Tip

Tipo: Channels