Application is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.
Definition
class Application : ApiEntity, IApiEntity, IApplication, IAuditable { Application(AdditionalInfo additionalInfo); Application(Error error); Application(Warning warning); Application(IApplication application); Application(IList<Warning> warnings, IList<Error> errors); Guid ApplicationId { get; } Guid ApplicationTypeId { get; } string AvatarUrl { get; } Container Container { get; } IList<Error> Errors { get; } bool IsEnabled { get; } string Url { get; } IList<Warning> Warnings { get; } bool HasErrors(); bool HasWarnings(); bool HasWarningsOrErrors(); string HtmlDescription(string target); string HtmlName(string target); void ThrowErrors(); }
Constructors
Application(AdditionalInfo additionalInfo);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| additionalInfo | AdditionalInfo | Additional Info | Required |
Application(Error error);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| error | Error | Error | Required |
Application(Warning warning);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warning | Warning | Warning | Required |
Application(IApplication application);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| application | IApplication | Application | Required |
Application(IList<Warning> warnings, IList<Error> errors);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warnings | IList<Warning> | Warnings | Required | ||
| errors | IList<Error> | Errors | Required |
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| 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 | Container | |||
| Errors | IList<Error> | |||
| IsEnabled | bool | A flag representing whether the application is enabled. | ||
| Url | string | A Url to the application on the site. | ||
| Warnings | IList<Warning> |
Methods
bool HasErrors();
Return Type
bool HasWarnings();
Return Type
bool HasWarningsOrErrors();
Return Type
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 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 |