telligentIdeas_v1_votes Script API

Enables scripted content fragments to use Idea Votes

Create
Delete
Get
List
Update

Methods

Create

Create Overload 1

OBSOLETE in 10.2: Use Create(Guid,int)

Velocity

#set($voteResponse = $telligentIdeas_v1_votes.Create($ideaId, $value))

JavaScript

var voteResponse = telligentIdeas_v1_votes.Create(ideaId, value);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
value	`Boolean`	Value	Required

Create Overload 2

Creates the specified amount of votes for an idea

Velocity

#set($voteResponse = $telligentIdeas_v1_votes.Create($ideaId, $value))

JavaScript

var voteResponse = telligentIdeas_v1_votes.Create(ideaId, value);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
value	`Int32`	Value	Required

Returns

Vote

Delete

Deletes a Vote

Velocity

#set($additionalInfoResponse = $telligentIdeas_v1_votes.Delete($ideaId, $userId))

JavaScript

var additionalInfoResponse = telligentIdeas_v1_votes.Delete(ideaId, userId);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
userId	`Int32`	User Id	Required

Returns

AdditionalInfo

Get

Gets a Vote

Velocity

#set($voteResponse = $telligentIdeas_v1_votes.Get($ideaId, $userId))

JavaScript

var voteResponse = telligentIdeas_v1_votes.Get(ideaId, userId);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
userId	`Int32`	User Id	Required

Returns

Vote

List

Returns a List of Votes

Velocity

#set($pagedListResponse = $telligentIdeas_v1_votes.List("%{ IdeaId = $ideaIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, UserId = $userIdArg, Value = $valueArg }"))

JavaScript

var pagedListResponse = telligentIdeas_v1_votes.List({ IdeaId: ideaIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, UserId: userIdArg, Value: valueArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
IdeaId	`Guid`	Idea Id	Optional
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
UserId	`Int32`	UserId of voter	Optional
Value	`Int32`	1 for 'Up' votes, 0 for 'down' votes	Optional

Returns

PagedList of Vote

Update

Update Overload 1

OBSOLETE in 10.2: Use Update(Guid,int)

Velocity

#set($voteResponse = $telligentIdeas_v1_votes.Update($ideaId, $value))

JavaScript

var voteResponse = telligentIdeas_v1_votes.Update(ideaId, value);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
value	`Boolean`	Value	Required

Update Overload 2

Updates the total number of votes for an idea.

Velocity

#set($voteResponse = $telligentIdeas_v1_votes.Update($ideaId, $value))

JavaScript

var voteResponse = telligentIdeas_v1_votes.Update(ideaId, value);

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Idea Id	Required
value	`Int32`	Value	Required

Returns

Vote