IApplication Plugin Supplementary Type

Ben Tiedt — Tue, 19 Nov 2019 19:38:11 GMT

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

IApplication is defined in the Telligent.Evolution.Extensibility.Content.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IApplication
{
	Guid ApplicationId { get;  }
	Guid ApplicationTypeId { get;  }
	string AvatarUrl { get;  }
	[[IContainer Plugin Supplementary Type|IContainer]] Container { get;  }
	bool IsEnabled { get;  }
	string Url { get;  }
	string HtmlDescription(string target);
	string HtmlName(string target);
}

Properties

Name	Type	Description
ApplicationId	`Guid`	A Guid uniquely identifying the application.
ApplicationTypeId	`Guid`	A Guid identifying the type of application. All applications of the same type (i.e. wiki) will have the same value here.
AvatarUrl	`string`	This can represent a Url to an image particular to the application or application type.
Container	`[[IContainer Plugin Supplementary Type\|IContainer]]`	The container in which the application is located.
IsEnabled	`bool`	A flag representing whether the application is enabled.
Url	`string`	A Url to the application on the site.

Methods

string HtmlDescription(string target);

This method should return the Html encoded description of the application. Possible values for “target” are “Web”, “Email”, “WebServices”, or “raw”. When “raw” is specified as the target, the description should not be encoded or have any special rendering done to it. If there is no description, an empty string should be returned.

Parameters

Name	Type	Description	Required	Default	Options
target	`string`	Target	Required

Return Type

string

string HtmlName(string target);

This method should return the Html encoded name of the application. Possible values for “target” are “Web”, “Email”, or “raw”. When “raw” is specified as the target, the name should not be encoded.

Parameters

Name	Type	Description	Required	Default	Options
target	`string`	Target	Required

Return Type

string