C# Class JustPressPlay.Controllers.JSONController

Handles all JSON requests.

Inheritance: Controller

Datei anzeigen Open project: RIT-MAGIC/JustPressPlay

Public Methods

Method	Description
Achievements ( int userID = null, int questID = null, bool achievementsEarned = null, bool inactiveAchievements = false, bool createPoints = null, bool explorePoints = null, bool learnPoints = null, bool socializePoints = null, int start = null, int count = null, String search = null ) : System.Web.Mvc.JsonResult	Returns a list of achievements
Comments ( int id = null, bool isAchievement = true, int earningID = null, int achievementID = null, int questID = null, int startComments = null, int countComments = null ) : System.Web.Mvc.JsonResult	Returns a list of comments for the specified earning
Earning ( int id, bool isAchievement ) : System.Web.Mvc.JsonResult
Earnings ( int id = null, int achievementID = null, int questID = null, bool friendsOf = false, int start = null, int count = null, int startComments = null, int countComments = null ) : System.Web.Mvc.JsonResult	Returns a list of earnings
Players ( int start = null, int count = null, int userID = null, bool friendsWith = null, int earnedAchievement = null, int earnedQuest = null ) : System.Web.Mvc.JsonResult	Returns a list of players
Quests ( int userID = null, bool completedQuests = false, bool partiallyCompletedQuests = false, bool incompleteQuests = false, bool inactiveQuests = false, bool trackedQuests = false, bool userGeneratedQuests = false, int start = null, int count = null, String search = null ) : System.Web.Mvc.JsonResult	Returns a list of quests

Method Details

Achievements() public method

Returns a list of achievements

public Achievements ( int userID = null, int questID = null, bool achievementsEarned = null, bool inactiveAchievements = false, bool createPoints = null, bool explorePoints = null, bool learnPoints = null, bool socializePoints = null, int start = null, int count = null, String search = null ) : System.Web.Mvc.JsonResult
userID	int	The id of a user for user-related searches
questID	int	Use this to return only achievements related to a particular quest.
achievementsEarned	bool	Should earned achievements be returned? Requires the userID parameter. Default is true.
inactiveAchievements	bool	Should inactive achievements be returned? Default is false.
createPoints	bool	Require create points?
explorePoints	bool	Require explore points?
learnPoints	bool	Require learn points?
socializePoints	bool	Require socialize points?
start	int
count	int
search	String	A string for searching
return	System.Web.Mvc.JsonResult

Comments() public method

Returns a list of comments for the specified earning

public Comments ( int id = null, bool isAchievement = true, int earningID = null, int achievementID = null, int questID = null, int startComments = null, int countComments = null ) : System.Web.Mvc.JsonResult
id	int	The id of the player whose earning should be looked up
isAchievement	bool	Is the comment for an achievement or quest
earningID	int	The id of the earning "instance"
achievementID	int	The id of the achievement template (Only needed if earningID is null)
questID	int	The id of the quest template (Only needed if earningID is null)
startComments	int	The zero-based index of the first comment to be returned
countComments	int	How many comments should be returned
return	System.Web.Mvc.JsonResult

Earning() public method

public Earning ( int id, bool isAchievement ) : System.Web.Mvc.JsonResult
id	int
isAchievement	bool
return	System.Web.Mvc.JsonResult

Earnings() public method

Returns a list of earnings

public Earnings ( int id = null, int achievementID = null, int questID = null, bool friendsOf = false, int start = null, int count = null, int startComments = null, int countComments = null ) : System.Web.Mvc.JsonResult
id	int	The id of the player whose earnings should be returned
achievementID	int	Use this to return earnings relating to the specified achievement
questID	int	/// Use this to return earnings relating to the achievements that correspond /// to the specified quest. This overrides the "achievementID" parameter.\ ///
friendsOf	bool	Return earnings of players who are friends with the specified player instead?
start	int	The zero-based index of the first earning to return
count	int	How many earnings should be returned?
startComments	int	The zero-based index of the first comment to be returned
countComments	int	How many comments should be returned?
return	System.Web.Mvc.JsonResult

Players() public method

Returns a list of players

public Players ( int start = null, int count = null, int userID = null, bool friendsWith = null, int earnedAchievement = null, int earnedQuest = null ) : System.Web.Mvc.JsonResult
start	int	The zero-based index of the first player to return
count	int	The total number of players to return
userID	int	The user ID for friend-related stuff
friendsWith	bool	True for friends, false for non-friends, null for everywhere
earnedAchievement	int	Only return players who earned the specified achievement (by id)
earnedQuest	int	Only return players who earned the specified quest (by id)
return	System.Web.Mvc.JsonResult

Quests() public method

Returns a list of quests

public Quests ( int userID = null, bool completedQuests = false, bool partiallyCompletedQuests = false, bool incompleteQuests = false, bool inactiveQuests = false, bool trackedQuests = false, bool userGeneratedQuests = false, int start = null, int count = null, String search = null ) : System.Web.Mvc.JsonResult
userID	int	The id of a user for user-related searches
completedQuests	bool	Only include completed quests?
partiallyCompletedQuests	bool	Only include partially completed quests?
incompleteQuests	bool	Only include fully incomplete quests?
inactiveQuests	bool	Include inactive quests?
trackedQuests	bool	Show only tracked quests?
userGeneratedQuests	bool	Include user generated quests?
start	int
count	int
search	String	A string for searching
return	System.Web.Mvc.JsonResult