Environment
Environment¶
Abstract
Summary of the Environment class
Class Description¶
The class represents an eLegere environment, such as esi.oncloud.com. An environment is an instance of eLegere.
The environment class does not have methods to modify data on eLegere: it acts as an intermediary class to interface with eLegere and its applications. The getEnvironment and getEnvironmentFromToken functions initialize the Environment class. The user can employ the functions through either username and password or session token or domain id.
Note
The class requires the initialization through the elegere object.
An Example:
1 |
|
Methods¶
getApplication Promise<Application>
¶
1 |
|
The getApplication()
method returns an initialized Application object from an application id and Domain id.
An Example:
1 |
|
Parameters¶
applicationId
string Id identifying the application.
domainId
string Id identifying the domain. The application must belong to the specified domain.
Return Value¶
Returns a Promise for an Application object.
getOrganization Promise<Organization>
¶
1 |
|
getOrganization takes an organization's name and returns an initialized Organization object.
An Example:
1 |
|
Parameters¶
organizationName
string Represents the name identifying the organization.
Return¶
Returns a Promise for a Organization object.