Cloud CMS JavaScript Driver Class: Application

Creates an object on the server using one URL and then reads it back using another URL.
This exists because the security responses don't include _doc fields like other responses.

Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`object`
`createUri`
`readUri`

Inherited From:

Gitana.Chainable#chainCreateEx

Source:

Chainable.js, line 194

chainDelete(chainable, uri, params)

Executes an HTTP delete for this object and continues the chain with the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.AbstractObject#chainDelete

Source:

AbstractObject.js, line 43

chainGet(chainable, uri, params)

Performs a GET from the server and populates the chainable.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.Chainable#chainGet

Source:

Chainable.js, line 118

chainGetResponse(chainable, uri, params)

Performs a GET to the server and pushes the response into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.Chainable#chainGetResponse

Source:

Chainable.js, line 374

chainGetResponseRows(chainable, uri, params)

Performs a GET to the server and pushes the "rows" response attribute into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.Chainable#chainGetResponseRows

Source:

Chainable.js, line 437

chainGetResponseText(chainable, uri, params)

Performs a GET to the server and pushes the text response to the callback.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.Chainable#chainGetResponseText

Source:

Chainable.js, line 405

chainHasResponseRow(chainable, uri, value)

Performs a GET to the server and checks whether the "rows" array attribute of the response
has the given value.

Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`value`

Inherited From:

Gitana.Chainable#chainHasResponseRow

Source:

Chainable.js, line 454

chainPatch(chainable, uri, params, payload)

Performs a PATCH to the server and populates the chainable with results.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`
`payload`

Inherited From:

Gitana.AbstractObject#chainPatch

Source:

AbstractObject.js, line 146

chainPost(chainable, uri, params, payload, handleFn)

Performs a POST to the server and populates the chainable with results.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`
`payload`
`handleFn`

Inherited From:

Gitana.Chainable#chainPost

Source:

Chainable.js, line 240

chainPostEmpty(chainable, uri, params, payload, contentType)

Performs a POST to the server. The response is not handled.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`
`payload`		(optional)
`contentType`		(optional) - example "text/plain"

Inherited From:

Gitana.Chainable#chainPostEmpty

Source:

Chainable.js, line 280

chainPostResponse(chainable, uri, params)

Performs a POST to the server and pushes the response into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.Chainable#chainPostResponse

Source:

Chainable.js, line 477

chainReload(uri, params)

Reloads this object from the server and then passes control to the chainable.

Parameters:

Name	Type	Description
`uri`
`params`

Inherited From:

Gitana.AbstractObject#chainReload

Source:

AbstractObject.js, line 74

chainUpdate(chainable, uri, params)

Executes an update (write + read) of this object and then passes control to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`

Inherited From:

Gitana.AbstractObject#chainUpdate

Source:

AbstractObject.js, line 107

chainUpload(chainable, uri, params, contentType, payload)

Performs a POST to the server. The response is not handled.
Proceeds with the chain as bound to the chainable.

Parameters:

Name	Type	Description
`chainable`
`uri`
`params`
`contentType`		(optional) - example "text/plain"
`payload`		(optional)

Inherited From:

Gitana.Chainable#chainUpload

Source:

Chainable.js, line 328

checkAuthority(principal, authorityId, callback)

Checks whether the given principal has a granted authority for this object.
This passes the result (true/false) to the chaining function.

Parameters:

Name	Type	Description
`principal`	Gitana.DomainPrincipal \| String	the principal or the principal id
`authorityId`	String	the id of the authority
`callback`

Inherited From:

Gitana.AbstractSelfableACLObject#checkAuthority

Source:

AbstractSelfableACLObject.js, line 86

checkEmailAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type email.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 1134

checkEmailPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type email.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 1091

checkEmailProviderAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type emailprovider.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 942

checkEmailProviderPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type emailprovider.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 899

checkMessageAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type message.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 1474

checkMessagePermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type message.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 1431

checkPageRenditionAuthorities(string, checks, callback)

Performs a bulk check of authorities against permissioned objects of type page rendition.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`string`	String	deployment key
`checks`
`callback`

Source:

application/Application.js, line 752

checkPageRenditionPermissions(string, checks, callback)

Performs a bulk check of permissions against permissioned objects of type page rendition.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`string`	String	deployment key
`checks`
`callback`

Source:

application/Application.js, line 708

checkPermission(principal, permissionId, callback)

Checks whether the given principal has a permission against this object.
This passes the result (true/false) to the chaining function.

Parameters:

Name	Type	Description
`principal`	Gitana.DomainPrincipal \| String	the principal or the principal id
`permissionId`	String	the id of the permission
`callback`

Inherited From:

Gitana.AbstractSelfableACLObject#checkPermission

Source:

AbstractSelfableACLObject.js, line 191

checkRegistrationAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type registration.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 557

checkRegistrationPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type registration.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 514

checkSettingAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type settings.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 367

checkSettingPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type settings.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:

Name	Type	Description
`checks`
`callback`

Source:

application/Application.js, line 324

clone()

Source:

application/Application.js, line 43

copy(target, asynchronous, config)

Copies this object into the target.

Parameters:

Name	Type	Description
`target`
`asynchronous`
`config`

Inherited From:

Gitana.AbstractPlatformObject#copy

Source:

platform/AbstractPlatformObject.js, line 188

createEmail( [Object])

Create email

Parameters:

Name	Type	Argument	Description
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 978

createEmailProvider( [Object])

Create email provider

Parameters:

Name	Type	Argument	Description
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 786

createMessage( [Object])

Create message

Parameters:

Name	Type	Argument	Description
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 1318

createPageRendition(string [, Object])

Create page rendition

Parameters:

Name	Type	Argument	Description
`string`	String		deployment key
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 591

createRegistration( [Object])

Create registration

Parameters:

Name	Type	Argument	Description
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 401

createSettings( [Object])

Create settings

Parameters:

Name	Type	Argument	Description
`Object`		<optional>	object JSON object

Source:

application/Application.js, line 120

del()

Delete

Inherited From:

Gitana.AbstractSelfableObject#del

Source:

AbstractSelfableObject.js, line 38

deploy(deploymentKey)

Deploys the application to the environment described by the deployment key.

Parameters:

Name	Type	Description
`deploymentKey`

Source:

application/Application.js, line 1167

exportArchive(settings)

Exports an archive.

Parameters:

Name	Type	Description
`settings`	Object

Inherited From:

Gitana.AbstractPlatformObject#exportArchive

Source:

platform/AbstractPlatformObject.js, line 71

extractPrincipalDomainQualifiedId(principal)

Helper to gets the principal id for a principal object, json structure or principal id itself.
This returns something like "domainId/principalId"

Parameters:

Name	Type	Description
`principal`

Inherited From:

Gitana.Chainable#extractPrincipalDomainQualifiedId

Source:

Chainable.js, line 508

extractPrincipalIdentifiers(principal, defaultDomainId)

Helper to gets the principal id for a principal object, json structure or principal id itself.
This returns something like "domainId/principalId"

Parameters:

Name	Type	Description
`principal`		principal object or string (principal id or domain qualified principal id)
`defaultDomainId`

Inherited From:

Gitana.Chainable#extractPrincipalIdentifiers

Source:

Chainable.js, line 522

findDeployedApplication(deploymentKey)

Finds the deployed application instance for a given target deployment key.

Parameters:

Name	Type	Description
`deploymentKey`

Source:

application/Application.js, line 1218

get(key)

Get a json property

Parameters:

Name	Type	Description
`key`

Inherited From:

Gitana.AbstractObject#get

Source:

AbstractObject.js, line 233

getDescription()

The description for the object.

Inherited From:

Gitana.AbstractObject#getDescription

Source:

AbstractObject.js, line 292

Returns:

the description

Type: String

getId()

Hands back the ID ("_doc") of this object.

Inherited From:

Gitana.AbstractObject#getId

Source:

AbstractObject.js, line 256

Returns:

Type: String

getProxiedUri()

Hands back the URI of this object as referenced by the browser.

Inherited From:

Gitana.AbstractObject#getProxiedUri

Source:

AbstractObject.js, line 223

getSystemMetadata()

Hands back the system metadata for this object.

Inherited From:

Gitana.AbstractObject#getSystemMetadata

Source:

AbstractObject.js, line 268

Returns:

system metadata

Type: Gitana.SystemMetadata

getTitle()

The title for the object.

Inherited From:

Gitana.AbstractObject#getTitle

Source:

AbstractObject.js, line 280

Returns:

the title

Type: String

getType()

Inherited From:

Gitana.AbstractObject#getType

Overrides:

Gitana.AbstractPlatformObject#getType

Source:

AbstractObject.js, line 205

getUri()

Inherited From:

Gitana.AbstractObject#getUri

Overrides:

Gitana.AbstractPlatformObject#getUri

Source:

AbstractObject.js, line 197

grantAuthority(principal, authorityId)

Grants an authority to a principal against this object.

Parameters:

Name	Type	Description
`principal`	Gitana.DomainPrincipal \| String	the principal or the principal id
`authorityId`	String	the id of the authority

Inherited From:

Gitana.AbstractSelfableACLObject#grantAuthority

Source:

AbstractSelfableACLObject.js, line 110

handleResponse(response)

Parameters:

Name	Type	Description
`response`

Inherited From:

Gitana.AbstractPersistable#handleResponse

Source:

AbstractPersistable.js, line 36

handleSystemProperties()

Gets called after the response is handled and allows the object to pull out special values from
the "object" field so that they don't sit on the JSON object

Inherited From:

Gitana.AbstractPersistable#handleSystemProperties

Source:

AbstractPersistable.js, line 57

importArchive(settings [, Function])

Imports an archive.

Parameters:

Name	Type	Argument	Description
`settings`	Object
`Function`		<optional>	reportFn

Inherited From:

Gitana.AbstractPlatformObject#importArchive

Source:

platform/AbstractPlatformObject.js, line 134

invalidateAllPageRenditions(deploymentKey)

Invalidates all page renditions for a given deployment

Parameters:

Name	Type	Description
`deploymentKey`

Source:

application/Application.js, line 1289

json()

Hands back a cleanup, properties-only JSON simple object.

Inherited From:

Gitana.AbstractPersistable#json

Source:

AbstractPersistable.js, line 66

listAuthorities(principal, callback)

Retrieve list of authorities and pass into chaining method.

Parameters:

Name	Type	Description
`principal`	Gitana.DomainPrincipal \| String	the principal or the principal id
`callback`

Inherited From:

Gitana.AbstractSelfableACLObject#listAuthorities

Source:

AbstractSelfableACLObject.js, line 60

listAutoClientMappingObjects(callback, pagination)

Lists the auto-client mappings maintained for this application.

Parameters:

Name	Type	Description
`callback`		the callback function
`pagination`

Source:

application/Application.js, line 56

listEmailProviders(pagination)

Lists the email providers.

Parameters:

Name	Type	Description
`pagination`

Source:

application/Application.js, line 807

listEmails(pagination)

Lists the emails.

Parameters:

Name	Type	Description
`pagination`

Source:

application/Application.js, line 999

listMessages(pagination)

Lists the messages.

Parameters:

Name	Type	Description
`pagination`

Source:

application/Application.js, line 1339

listPageRenditions(string, pagination)

Lists the page renditions.

Parameters:

Name	Type	Description
`string`	String	deployment key
`pagination`

Source:

application/Application.js, line 613

listRegistrations(pagination)

Lists the registrations.

Parameters:

Name	Type	Description
`pagination`

Source:

application/Application.js, line 422

listSettings(pagination)

Lists the settings.

Parameters:

Name	Type	Description
`pagination`

Source:

application/Application.js, line 146

listTrustedDomainMappingObjects(callback, pagination)

Lists the trusted domain mappings maintained for this application.

Parameters:

Name	Type	Description
`callback`		the callback function
`pagination`

Source:

application/Application.js, line 85

loadACL(callback)

Retrieve full ACL and pass into chaining method.

Parameters:

Name	Type	Description
`callback`

Inherited From:

Gitana.AbstractSelfableACLObject#loadACL

Source:

AbstractSelfableACLObject.js, line 38

loadAuthorityGrants(callback)

Loads the authority grants for a given set of principals.

Parameters:

Name	Type	Description
`callback`

Inherited From:

Gitana.AbstractSelfableACLObject#loadAuthorityGrants

Source:

AbstractSelfableACLObject.js, line 165

loadDeploymentInfo(deploymentKey)

Retrieves information about a deployed application.

Parameters:

Name	Type	Description
`deploymentKey`

Source:

application/Application.js, line 1248

loadFrom(anotherObject)

Helper method that loads this object from another object of the same type.

For example, loading a node from another loaded node.

Parameters:

Name	Type	Description
`anotherObject`

Inherited From:

Gitana.AbstractObject#loadFrom

Source:

AbstractObject.js, line 377

queryEmailProviders(query [, Object])

Queries for email providers.

Parameters:

Name	Type	Argument	Description
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 855

queryEmails(query [, Object])

Queries for emails.

Parameters:

Name	Type	Argument	Description
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 1047

queryMessages(query [, Object])

Queries for messages.

Parameters:

Name	Type	Argument	Description
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 1387

queryPageRenditions(string, query [, Object])

Queries for page renditions.

Parameters:

Name	Type	Argument	Description
`string`	String		deployment key
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 663

queryRegistrations(query [, Object])

Queries for registrations.

Parameters:

Name	Type	Argument	Description
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 470

querySettings(query [, Object])

Queries for settings.

Parameters:

Name	Type	Argument	Description
`query`	Object
`Object`		<optional>	pagination pagination (optional)

Source:

application/Application.js, line 193

readApplicationPrincipalSettings()

Reads the principal settings. It takes either a single Gitana.DomainPrincipal parameter
or a domain Id parameter and a principal Id parameter.

Source:

application/Application.js, line 281

readApplicationSettings(scope, key)

Reads the application settings for the given scope and key.
If the settings doesn't exist, creates an empty one.

Parameters:

Name	Type	Description
`scope`	String	(optional)
`key`	String	(optional)

Source:

application/Application.js, line 219

readEmail(emailId)

Reads an email.

Parameters:

Name	Type	Description
`emailId`

Source:

application/Application.js, line 1025

readEmailProvider(emailProviderId)

Reads an email provider.

Parameters:

Name	Type	Description
`emailProviderId`

Source:

application/Application.js, line 833

readMessage(messageId)

Reads a message.

Parameters:

Name	Type	Description
`messageId`

Source:

application/Application.js, line 1365

readPageRendition(string, pageRenditionIdOrKey)

Reads a page rendition.

Parameters:

Name	Type	Description
`string`	String	deployment key
`pageRenditionIdOrKey`

Source:

application/Application.js, line 640

readRegistration(registrationId)

Reads a registration.

Parameters:

Name	Type	Description
`registrationId`

Source:

application/Application.js, line 448

readSettings(settingId)

Reads an setting.

Parameters:

Name	Type	Description
`settingId`

Source:

application/Application.js, line 172

ref()

Inherited From:

Gitana.AbstractObject#ref

Source:

AbstractObject.js, line 215

Returns:

a string denoting a reference to this object.

Type: String

reload()

Reload

Inherited From:

Gitana.AbstractSelfableObject#reload

Source:

AbstractSelfableObject.js, line 58

replacePropertiesWith(object)

Replaces all of the properties of this object with those of the given object.
This method should be used to update the state of this object.

Any functions from the incoming object will not be copied.

Parameters:

Name	Type	Description
`object`	Object	object containing the properties

Inherited From:

Gitana.AbstractObject#replacePropertiesWith

Source:

AbstractObject.js, line 315

revokeAllAuthorities(principal)

Revokes all authorities for a principal against the server.

Parameters:

Name	Type	Description
`principal`	Gitana.Principal \| String	the principal or the principal id

Inherited From:

Gitana.AbstractSelfableACLObject#revokeAllAuthorities

Source:

AbstractSelfableACLObject.js, line 153

revokeAuthority(principal, authorityId)

Revokes an authority from a principal against this object.

Parameters:

Name	Type	Description
`principal`	Gitana.DomainPrincipal \| String	the principal or the principal id
`authorityId`	String	the id of the authority

Inherited From:

Gitana.AbstractSelfableACLObject#revokeAuthority

Source:

AbstractSelfableACLObject.js, line 132

set(key, value)

Set a json property

Parameters:

Name	Type	Description
`key`
`value`

Inherited From:

Gitana.AbstractObject#set

Source:

AbstractObject.js, line 244

stringify(pretty)

Helper function to convert the object portion to JSON

Parameters:

Name	Type	Description
`pretty`

Inherited From:

Gitana.AbstractObject#stringify

Source:

AbstractObject.js, line 365

undeploy(deploymentKey)

Undeploys the application from the environment described by the deployment key.

Parameters:

Name	Type	Description
`deploymentKey`

Source:

application/Application.js, line 1199

update()

Update

Inherited From:

Gitana.AbstractSelfableObject#update

Source:

AbstractSelfableObject.js, line 77