IManageableApplicationType (v2) Plugin Type

Ben Tiedt — Tue, 19 Nov 2019 19:35:33 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:35:33

IManageableApplicationType is defined in the Telligent.Evolution.Extensibility.Content.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface IManageableApplicationType : [[IApplicationType Plugin Type|IApplicationType]], [[IPlugin Plugin Type|IPlugin]], [[IQueryableApplicationType Plugin Type|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 Plugin Supplementary Type|IApplication]] Create(int userId, Guid containerTypeId, Guid containerId, [[IReadOnlyConfigurationData Plugin Supplementary Type|IReadOnlyConfigurationData]] createConfigurationData);
	void Delete(int userId, Guid applicationId);
	[[PropertyGroup Plugin Supplementary Type|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
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
userId	`int`	User Id	Required
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required
createConfigurationData	`[[IReadOnlyConfigurationData Plugin Supplementary Type\|IReadOnlyConfigurationData]]`	Create Configuration Data	Required

Return Type

[[IApplication Plugin Supplementary Type|IApplication]]

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
userId	`int`	User Id	Required
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required

Return Type

[[PropertyGroup Plugin Supplementary Type|PropertyGroup]][]

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
userId	`int`	User Id	Required
applicationId	`Guid`	Application Id	Required
enabled	`bool`	Enabled	Required