Deployment Element

DeploymentElement

DeploymentElement Objects

class DeploymentElement()

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

constructor

function constructor()

Arguments:

• context *
• ogapi *
• url *
• progressEvent *

createWithFile

function createWithFile(rawFile: File) -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement

Arguments:

• rawFile File - this File is the deployment element

Returns:

• Promise

deploy

function deploy() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement with previously assignated file

Returns:

• Promise

update

function update()

This method invalidates the update option

validation

function validation()

validation

function validation()

withDownloadUrl

function withDownloadUrl(downloadUrl: string) -> 'DeploymentElement'

Set the downloadUrl attribute

Arguments:

• downloadUrl string

Returns:

• DeploymentElement

withFile

function withFile(rawFile: object) -> 'DeploymentElement'

Sets the file to upload

Arguments:

• rawFile object

Returns:

• DeploymentElement

withFileName

function withFileName(fileName: string) -> 'DeploymentElement'

Set the fileName attribute

Arguments:

• fileName string

Returns:

• DeploymentElement

withName

function withName(name: string) -> 'DeploymentElement'

Set the name attribute

Arguments:

• name string - required field

Returns:

• DeploymentElement

withOldName

function withOldName(name: string) -> 'DeploymentElement'

Sets the old name attribute

Arguments:

• name string

Returns:

• DeploymentElement

withOldPath

function withOldPath(path: string) -> 'DeploymentElement'

Sets the old path attribute

Arguments:

• path string

Returns:

• DeploymentElement

withOldVersion

function withOldVersion(version: string) -> 'DeploymentElement'

Sets the old version attribute

Arguments:

• version string

Returns:

• DeploymentElement

withOperation

function withOperation(operation: string) -> 'DeploymentElement'

Set the operation attribute

Arguments:

• operation string - required field

Returns:

• DeploymentElement

withOption

function withOption(option: string) -> 'DeploymentElement'

Set the option attribute

Arguments:

• option string

Returns:

• DeploymentElement

withOrder

function withOrder(order: string) -> 'DeploymentElement'

Set the order attribute

Arguments:

• order string - required field

Returns:

• DeploymentElement

withPath

function withPath(path: string) -> 'DeploymentElement'

Set the path attribute

Arguments:

• path string - required field

Returns:

• DeploymentElement

withTimeout

function withTimeout(ms: number) -> 'Bundles'

The request will have a specific time out if it will be exceeded then the promise throw an exception

Arguments:

• ms number - timeout in milliseconds

Returns:

• Bundles

withType

function withType(type: string) -> 'DeploymentElement'

Set the type attribute

Arguments:

• type string - required field

Returns:

• DeploymentElement

withValidation

function withValidation(validation: string) -> 'DeploymentElement'

Set the validation attribute

Arguments:

• validation string

Returns:

• DeploymentElement

withValidators

function withValidators(validators: Array) -> 'DeploymentElement'

Set the validators attribute

Arguments:

• validators Array

Returns:

• DeploymentElement

withVersion

function withVersion(version: string) -> 'DeploymentElement'

Set the version attribute

Arguments:

• version string - required field

Returns:

• DeploymentElement