RestRequest
Extends:
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(): {"identifier": *, "schedule": *, "restRequest": *, "response": *} |
|
| 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 |
withScheduleExecuteNow(executeNow: boolean): RestRequest Sets the executeNow attribute |
|
| public |
withScheduleFrom(from: string): RestRequest Sets the from attribute |
|
| public |
withScheduleMinutesInterval(interval: number): RestRequest Sets the interval for schedule in minutes |
|
| public |
withScheduleTo(to: string): RestRequest Sets the to attribute |
|
| 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 |
This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision |
|
| public |
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#constructorParams:
| Name | Type | Attribute | Description |
| Reference | InternalOpenGateAPI | to the API object. |
Public Methods
public toJson(): {"identifier": *, "schedule": *, "restRequest": *, "response": *} source
Return:
| {"identifier": *, "schedule": *, "restRequest": *, "response": *} |
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#updatepublic withAsyncResponseMaxTimeToWaitCallback(asyncResponseMaxTimeToWaitCallback: string): RestRequest source
Sets the async response with selected timeout
Params:
| Name | Type | Attribute | Description |
| asyncResponseMaxTimeToWaitCallback | string |
public withBody(restRequestBody: string): RestRequest source
Sets the body for restRequest
Params:
| Name | Type | Attribute | Description |
| restRequestBody | string |
public withHeaders(restRequestHeaders: string): RestRequest source
Sets the header for restRequest
Params:
| Name | Type | Attribute | Description |
| restRequestHeaders | string |
public withIdentifier(identifier: string): RestRequest source
Sets the identifier attribute
Params:
| Name | Type | Attribute | Description |
| identifier | string |
public withMethod(restRequestMethod: string): RestRequest source
Sets the method for restRequest
Params:
| Name | Type | Attribute | Description |
| restRequestMethod | string |
public withOrganization(organization: string): Channels source
Set the organization attribute
Params:
| Name | Type | Attribute | Description |
| organization | string |
public withScheduleCronExpression(cronExpression: string): RestRequest source
Sets the crontab expression for schedule
Params:
| Name | Type | Attribute | Description |
| cronExpression | string |
public withScheduleExecuteNow(executeNow: boolean): RestRequest source
Sets the executeNow attribute
Params:
| Name | Type | Attribute | Description |
| executeNow | boolean |
public withScheduleFrom(from: string): RestRequest source
Sets the from attribute
Params:
| Name | Type | Attribute | Description |
| from | string |
public withScheduleMinutesInterval(interval: number): RestRequest source
Sets the interval for schedule in minutes
Params:
| Name | Type | Attribute | Description |
| interval | number | in minutes |
public withScheduleTo(to: string): RestRequest source
Sets the to attribute
Params:
| Name | Type | Attribute | Description |
| to | string |
public withSyncResponseTimeout(syncResponseTimeout: string): RestRequest source
Sets the sync response with selected timeout
Params:
| Name | Type | Attribute | Description |
| syncResponseTimeout | string |
public withUrl(restRequestUrl: string): RestRequest source
Sets the url for restRequest
Params:
| Name | Type | Attribute | Description |
| restRequestUrl | string |