Content created on the site must implement this interface for the social services to support it.
Challenge is defined in the Telligent.Evolution.Extensibility.Ideation.Api namespace.
Definition
class Challenge : ApiEntity, IApiEntity, IApplication, IAuditable, IContent { Challenge(); Challenge(AdditionalInfo additionalInfo); Challenge(IList<Warning> warnings, IList<Error> errors); bool AllowMultipleVotes { get; } Guid ApplicationId { get; } string ApplicationKey { get; } Guid ApplicationTypeId { get; } string AvatarUrl { get; } Guid ContentId { get; } DateTime CreatedDate { get; } IList<Error> Errors { get; } Group Group { get; } Guid Id { get; } bool IsEnabled { get; } bool IsModerated { get; } DateTime? LastPostDate { get; } int? MaximumVotesPerIdea { get; } int? MaximumVotesPerUser { get; } string Name { get; } bool RequiresCategory { get; } string SearchUniqueId { get; } int TotalPosts { get; } string Url { get; } IList<Warning> Warnings { get; } string Description(); string Description(string target); bool HasErrors(); bool HasWarnings(); bool HasWarningsOrErrors(); string HtmlDescription(string target); string HtmlName(string target); void ThrowErrors(); }
Constructors
Challenge();
Challenge(AdditionalInfo additionalInfo);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| additionalInfo | AdditionalInfo | Additional Info | Required |
Challenge(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 |
|---|---|---|---|---|
| AllowMultipleVotes | bool | |||
| ApplicationId | Guid | A Guid uniquely identifying the application. | ||
| ApplicationKey | string | |||
| 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 | Url to an image particular to the content or content type. If none, return null. | ||
| ContentId | Guid | A Guid uniquely identifying the content. | ||
| CreatedDate | DateTime | The date the content was created. | ||
| Errors | IList<Error> | |||
| Group | Group | |||
| Id | Guid | |||
| IsEnabled | bool | A flag representing whether the content is enabled. This can be a wrapper for approval states, etc. | ||
| IsModerated | bool | |||
| LastPostDate | DateTime? | |||
| MaximumVotesPerIdea | int? | |||
| MaximumVotesPerUser | int? | |||
| Name | string | |||
| RequiresCategory | bool | |||
| SearchUniqueId | string | |||
| TotalPosts | int | |||
| Url | string | A Url to the content on the site. | ||
| Warnings | IList<Warning> |
Methods
string Description();
Return Type
string Description(string target);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| target | string | Target | Required |
Return Type
bool HasErrors();
Return Type
bool HasWarnings();
Return Type
bool HasWarningsOrErrors();
Return Type
string HtmlDescription(string target);
Return the Html encoded description of the content (the body, for example). 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.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| target | string | Target | Required |
Return Type
string HtmlName(string target);
Return the Html encoded name of the content (the subject for example). 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 |