Idea In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:34:53 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:34:53

Content created on the site must implement this interface for the social services to support it.

Idea is defined in the Telligent.Evolution.Extensibility.Ideation.Api namespace of Telligent.Evolution.Ideation.dll

Definition

class Idea
{
	[[User In-Process API Supplementary Type|User]] Author { get;  }
	[[IdeaCategory In-Process API Supplementary Type|IdeaCategory]] Category { get;  }
	[[Challenge In-Process API Supplementary Type|Challenge]] Challenge { get;  }
	Guid ContentId { get;  }
	DateTime CreatedDate { get;  }
	[[IdeaStatus In-Process API Supplementary Type|IdeaStatus]] CurrentStatus { get;  }
	Guid Id { get;  }
	bool IsEnabled { get;  }
	bool IsSuspectedAbusive { get;  }
	DateTime LastUpdatedDate { get;  }
	string Name { get;  }
	int NoVotes { get;  }
	int Score { get;  }
	string SearchUniqueId { get;  }
	[[Status In-Process API Supplementary Type|Status]] Status { get;  }
	[[User In-Process API Supplementary Type|User]] StatusAuthor { get;  }
	DateTime? StatusDate { get;  }
	int TotalVotes { get;  }
	string Url { get;  }
	string UrlKey { get;  }
	int YesVotes { get;  }
	string Description();
	string Description(string target);
	string HtmlDescription(string target);
	string StatusNotes();
	string StatusNotes(string target);
}

Properties

Name	Type	Description
Author	`[[User In-Process API Supplementary Type\|User]]`
Category	`[[IdeaCategory In-Process API Supplementary Type\|IdeaCategory]]`
Challenge	`[[Challenge In-Process API Supplementary Type\|Challenge]]`
ContentId	`Guid`	A Guid uniquely identifying the content.
CreatedDate	`DateTime`	The date the content was created.
CurrentStatus	`[[IdeaStatus In-Process API Supplementary Type\|IdeaStatus]]`
Id	`Guid`
IsEnabled	`bool`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
IsSuspectedAbusive	`bool`
LastUpdatedDate	`DateTime`
Name	`string`
NoVotes	`int`
Score	`int`
SearchUniqueId	`string`
Status	`[[Status In-Process API Supplementary Type\|Status]]`
StatusAuthor	`[[User In-Process API Supplementary Type\|User]]`
StatusDate	`DateTime?`
TotalVotes	`int`
Url	`string`	A Url to the content on the site.
UrlKey	`string`
YesVotes	`int`

Methods

string Description();

Return Type

string

string Description(string target);

Parameters

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

Return Type

string

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

string StatusNotes();

Return Type

string

string StatusNotes(string target);

Parameters

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

Return Type

string