Subsections of channels

Channel Finder

This class allow make get request to channel resource into 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 that returns channels related

Parámetros

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

Retorna

Tip

Tipo: Promise


findByDomainAndWorkgroupAndOrganization(domain, workgroup, organization)

Performs a get that returns channels related

Parámetros

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

Retorna

Tip

Tipo: Promise


findByOrganizationAndName(organization, name)

Download a specific channel by its organization and id. This execute 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 all you can do about Bundles.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI 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