Home Manual Reference Source Test Repository
public class | source

Domains

Extends:

BaseProvision → Domains

This is a base object that contains all you can do about Bundles.

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

withDescription(description: string): Domains

Set the description attribute

public

Set the name attribute

public

withParentDomain(parentDomain: string): Domains

Set the parentDomain attribute

Inherited Summary

From class BaseProvision
public

This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision

public

delete(body: *): Promise

This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision

public

This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

NameTypeAttributeDescription
Reference InternalOpenGateAPI

to the API object.

Public Methods

public withDescription(description: string): Domains source

Set the description attribute

Params:

NameTypeAttributeDescription
description string

required field

Return:

Domains

public withName(name: string): Domains source

Set the name attribute

Params:

NameTypeAttributeDescription
name string

required field

Return:

Domains

public withParentDomain(parentDomain: string): Domains source

Set the parentDomain attribute

Params:

NameTypeAttributeDescription
parentDomain string

Return:

Domains