IManageableApplicationType is defined in the Telligent.Evolution.Extensibility.Content.Version2 namespace of Telligent.Evolution.Platform.dll
Definition
interface IManageableApplicationType : IApplicationType, IPlugin, IQueryableApplicationType { bool CanCreate(int userId, Guid containerTypeId, Guid containerId); bool CanDelete(int userId, Guid applicationId); bool CanEdit(int userID, Guid applicationId); bool CanSetEnabled(int userId, Guid applicationId); IApplication Create(int userId, Guid containerTypeId, Guid containerId, IReadOnlyConfigurationData createConfigurationData); void Delete(int userId, Guid applicationId); PropertyGroup[] GetCreateConfiguration(int userId, Guid containerTypeId, Guid containerId); void SetEnabled(int userId, Guid applicationId, bool enabled); }
Methods
bool CanCreate(int userId, Guid containerTypeId, Guid containerId);
Returns true if the provided user can create an instance of this application type within the provided container.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| containerTypeId | Guid | Container Type Id | Required | ||
| containerId | Guid | Container Id | Required |
Return Type
bool
bool CanDelete(int userId, Guid applicationId);
Returns true if the provided user can delete the provided application.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| applicationId | Guid | Application Id | Required |
Return Type
bool
bool CanEdit(int userID, Guid applicationId);
Returns true if the provided user can edit the provided application.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userID | int | User I D | Required | ||
| applicationId | Guid | Application Id | Required |
Return Type
bool
bool CanSetEnabled(int userId, Guid applicationId);
Returns true if the provided user can modify the enabled status of the provided application.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| applicationId | Guid | Application Id | Required |
Return Type
bool
IApplication Create(int userId, Guid containerTypeId, Guid containerId, IReadOnlyConfigurationData createConfigurationData);
Creates a new instance of this application type using the provided configuration data. Any errors should be returned via throwing an IUserRenderableException.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| containerTypeId | Guid | Container Type Id | Required | ||
| containerId | Guid | Container Id | Required | ||
| createConfigurationData | IReadOnlyConfigurationData | Create Configuration Data | Required |
Return Type
void Delete(int userId, Guid applicationId);
Deletes an application. Any errors should be returned via throwing an IUserRenderableException.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| applicationId | Guid | Application Id | Required |
PropertyGroup[] GetCreateConfiguration(int userId, Guid containerTypeId, Guid containerId);
Returns the configuration fields requires to create a new instance of this application type.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| containerTypeId | Guid | Container Type Id | Required | ||
| containerId | Guid | Container Id | Required |
Return Type
void SetEnabled(int userId, Guid applicationId, bool enabled);
Sets the enabled status of an application. Any errors should be returned via throwing an IUserRenderableException.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | int | User Id | Required | ||
| applicationId | Guid | Application Id | Required | ||
| enabled | bool | Enabled | Required |