import RestRequest from 'opengate-js/src/schedule/RestRequest.js'

public class | source

RestRequest

Extends:

BaseProvision → RestRequest

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	toJson(): *
public	update()
public	withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): RestRequest Sets the async response with selected timeout
public	withBody(restRequestBody: string): RestRequest Sets the body for restRequest
public	withHeaders(restRequestHeaders: string): RestRequest Sets the header for restRequest
public	withIdentifier(identifier: string): RestRequest Sets the identifier attribute
public	withMethod(restRequestMethod: string): RestRequest Sets the method for restRequest
public	withOrganization(organization: string): Channels Set the organization attribute
public	withScheduleCronExpression(cronExpression: string): RestRequest Sets the crontab expression for schedule
public	withScheduleImmediateExecution(isImmediateExecution: boolean): RestRequest Sets the isImmediateExecution attribute for schedule
public	withSyncResponseTimeout(syncResponseTimeout: string): RestRequest Sets the sync response with selected timeout
public	withUrl(restRequestUrl: string): RestRequest Sets the url for restRequest

Inherited Summary

From class BaseProvision
public	create(): Promise 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	update(): Promise 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:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public toJson(): * source

Return:

public update() source

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

Override:

BaseProvision#update

public withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): RestRequest source

Sets the async response with selected timeout

Params:

Name	Type	Attribute	Description
asyncResponseMaxTimeToWaitCallback	string

Return:

RestRequest

public withBody(restRequestBody: string): RestRequest source

Sets the body for restRequest

Params:

Name	Type	Attribute	Description
restRequestBody	string

Return:

RestRequest

public withHeaders(restRequestHeaders: string): RestRequest source

Sets the header for restRequest

Params:

Name	Type	Attribute	Description
restRequestHeaders	string

Return:

RestRequest

public withIdentifier(identifier: string): RestRequest source

Sets the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string

Return:

RestRequest

public withMethod(restRequestMethod: string): RestRequest source

Sets the method for restRequest

Params:

Name	Type	Attribute	Description
restRequestMethod	string

Return:

RestRequest

public withOrganization(organization: string): Channels source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string

Return:

Channels

public withScheduleCronExpression(cronExpression: string): RestRequest source

Sets the crontab expression for schedule

Params:

Name	Type	Attribute	Description
cronExpression	string

Return:

RestRequest

public withScheduleImmediateExecution(isImmediateExecution: boolean): RestRequest source

Sets the isImmediateExecution attribute for schedule

Params:

Name	Type	Attribute	Description
isImmediateExecution	boolean

Return:

RestRequest

public withSyncResponseTimeout(syncResponseTimeout: string): RestRequest source

Sets the sync response with selected timeout

Params:

Name	Type	Attribute	Description
syncResponseTimeout	string

Return:

RestRequest

public withUrl(restRequestUrl: string): RestRequest source

Sets the url for restRequest

Params:

Name	Type	Attribute	Description
restRequestUrl	string

Return:

RestRequest