Constructor
new Application(applicationID, config)
The constructor function is a special function that is called when an object is created from a class
| Name | Type | Description |
|---|---|---|
applicationID | string | The ID of the application you want to use. |
config | Config | This is the configuration object that is passed to the constructor of the base class. |
Extends
- SetConfig
Methods
createAPIKey(payload) → {Output-CreateAPIKey}
It creates an API key for the application.
| Name | Type | Description |
|---|---|---|
payload | Input-CreateAPIKeyForApplication | Input-CreateAPIKeyForApplication |
The response from the API.
- Type:
- Output-CreateAPIKey
deleteApplication() → {Output-EmptyPayload}
It deletes the application.
The response from the API.
- Type:
- Output-EmptyPayload
getAPIKeyInfo(payload) → {Output-GetAPIKeyInfo}
It returns the API key information for the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetAPIKeyInfo | Input-GetAPIKeyInfo |
The response from the API.
- Type:
- Output-GetAPIKeyInfo
getAPIKeyList(payloadopt) → {Output-GetAPIKeyList}
It returns the list of API keys for the application.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetAPIKeyList | <optional> | Input-GetAPIKeyList |
The response from the API.
- Type:
- Output-GetAPIKeyList
getApplicationInfo() → {Output-GetApplication}
It returns the application information.
The response from the API.
- Type:
- Output-GetApplication
getApplicationList(payloadopt) → {Output-GetApplicationList}
It returns the list of applications that have been created by both user and organization (Default returns ).
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetApplicationList | <optional> | Input-GetApplicationList |
The response from the API.
getApplicationRight() → {Output-GetApplicationRight}
It returns the application rights.
The response from the API.
getCollaboratorInfoOfOrg(payload) → {Output-GetCollaboratorInfoOfOrg}
It returns rights of the collaborator (member) of the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetCollaboratorInfoOfOrg | Input-GetCollaboratorInfoOfOrg |
The response from the API.
getCollaboratorInfoOfUser(payload) → {Output-GetCollaboratorInfoOfUser}
It returns rights of the collaborator (member) of the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetCollaboratorInfoOfUser | Input-GetCollaboratorInfoOfUser |
The response from the API.
getCollaboratorList(payloadopt) → {Output-GetCollabortorList}
It returns the list of collaborators (members) of the application.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetCollabortorList | <optional> | Input-GetCollabortorList |
The response from the API.
purgeApplication() → {Output-EmptyPayload}
It purges the application.
The response from the API.
- Type:
- Output-EmptyPayload
restoreApplication() → {Output-EmptyPayload}
It restores the application.
The response from the API.
- Type:
- Output-EmptyPayload
searchApplication() → {Output-SearchApplication}
It searches the application.
The response from the API.
- Type:
- Output-SearchApplication
setCollaboratorOfOrg(payload) → {Output-EmptyPayload}
It sets the rights of a collaborator (member) on the application.
| Name | Type | Description |
|---|---|---|
payload | Input-SetCollaboratorOfOrg | Input-SetCollaboratorOfOrg |
The response from the API.
- Type:
- Output-EmptyPayload
setCollaboratorOfUser(payload) → {Output-EmptyPayload}
It sets the rights of a collaborator (member) on the application.
| Name | Type | Description |
|---|---|---|
payload | Input-SetCollaboratorOfUser | Input-SetCollaboratorOfUser |
The response from the API.
- Type:
- Output-EmptyPayload
updateAPIKey(payload) → {Output-UpdateAPIKey}
It returns the information of the api key that has been created by the user.
| Name | Type | Description |
|---|---|---|
payload | Input-UpdateAPIKeyOfApplication | Input-UpdateAPIKeyOfApplication |
The response from the API.
- Type:
- Output-UpdateAPIKey
updateApplication(payload) → {Output-UpdateApplication}
It updates the application information.
| Name | Type | Description |
|---|---|---|
payload | Input-UpdateApplication | Input-UpdateApplication |
The response from the API.
- Type:
- Output-UpdateApplication