org.craftercms.social.controllers.rest.v3.comments

Class ThreadsController

java.lang.Object

org.craftercms.social.controllers.rest.v3.comments.ThreadsController

@Controller
 @RequestMapping(value="/api/3/threads")
public class ThreadsController
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_INT

Constructor Summary

Constructors

Constructor and Description
ThreadsController()

Method Summary

Modifier and Type	Method and Description
boolean	changeSubscribe(String id, String frequency, String context)
boolean	changeSubscribePost(String id, String frequency, String context)
Thread	comments(String id, String commentId, int recursive, int pageNumber, int pageSize, int childrenCount, List<String> sortBy, List<SocialSortOrder> sortOrder)
static List<org.apache.commons.collections4.keyvalue.DefaultKeyValue<String,Boolean>>	getSortOrder(List<String> sortFields, List<SocialSortOrder> sortOrder)
static int	getStart(int page, int pageSize)
boolean	subscribe(String id, String frequency, String context)
List<Map>	subscriptions(String context)
Thread	thread(String id, int recursive, int pageNumber, int pageSize, int childrenCount, List<String> sortBy, List<SocialSortOrder> sortOrder)
boolean	unSubscribe(String id, String context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_INT

public static final String MAX_INT

See Also:

Constant Field Values

Constructor Detail

ThreadsController

public ThreadsController()

Method Detail

thread

@RequestMapping(value="{id}/comments",
                method=GET)
 @ResponseBody
public Thread thread(@PathVariable
                                                                                                       String id,
                                                                                                       @RequestParam(required=false,defaultValue="666")
                                                                                                       int recursive,
                                                                                                       @RequestParam(required=false,defaultValue="0")
                                                                                                       int pageNumber,
                                                                                                       @RequestParam(required=false,defaultValue="666")
                                                                                                       int pageSize,
                                                                                                       @RequestParam(required=false,defaultValue="666")
                                                                                                       int childrenCount,
                                                                                                       @RequestParam(required=false)
                                                                                                       List<String> sortBy,
                                                                                                       @RequestParam(required=false)
                                                                                                       List<SocialSortOrder> sortOrder)
                                                                                                throws SocialException

Throws:

SocialException

comments

@RequestMapping(value="{id}/comments/{commentId}/children",
                method=GET)
 @ResponseBody
public Thread comments(@PathVariable
                                                                                                                              String id,
                                                                                                                              @PathVariable
                                                                                                                              String commentId,
                                                                                                                              @RequestParam(required=false,defaultValue="666")
                                                                                                                              int recursive,
                                                                                                                              @RequestParam(required=false,defaultValue="0")
                                                                                                                              int pageNumber,
                                                                                                                              @RequestParam(required=false,defaultValue="666")
                                                                                                                              int pageSize,
                                                                                                                              @RequestParam(required=false,defaultValue="666")
                                                                                                                              int childrenCount,
                                                                                                                              @RequestParam(required=false)
                                                                                                                              List<String> sortBy,
                                                                                                                              @RequestParam(required=false)
                                                                                                                              List<SocialSortOrder> sortOrder)
                                                                                                                       throws SocialException

Throws:

SocialException

subscribe

@RequestMapping(value="{id}/subscribe",
                method=POST)
 @ResponseBody
public boolean subscribe(@PathVariable
                                                                                                             String id,
                                                                                                             @RequestParam(required=false,defaultValue="")
                                                                                                             String frequency,
                                                                                                             @RequestParam
                                                                                                             String context)
                                                                                                      throws UGCException

Throws:

UGCException

changeSubscribe

@RequestMapping(value="{id}/subscribe",
                method=PUT)
 @ResponseBody
public boolean changeSubscribe(@PathVariable
                                                                                                                  String id,
                                                                                                                  @RequestParam(required=false,defaultValue="")
                                                                                                                  String frequency,
                                                                                                                  @RequestParam
                                                                                                                  String context)
                                                                                                           throws UGCException

Throws:

UGCException

changeSubscribePost

@RequestMapping(value="{id}/subscribe/update",
                method=POST)
 @ResponseBody
public boolean changeSubscribePost(@PathVariable
                                                                                                                              String id,
                                                                                                                              @RequestParam(required=false,defaultValue="")
                                                                                                                              String frequency,
                                                                                                                              @RequestParam
                                                                                                                              String context)
                                                                                                                       throws UGCException

Throws:

UGCException

subscriptions

@RequestMapping(value="/subscriptions",
                method=GET)
 @ResponseBody
public List<Map> subscriptions(@RequestParam
                                                                                                                  String context)
                                                                                                           throws SocialException

Throws:

SocialException

unSubscribe

@RequestMapping(value="{id}/unsubscribe",
                method={POST,DELETE})
 @ResponseBody
public boolean unSubscribe(@PathVariable
                                                                                                                          String id,
                                                                                                                          @RequestParam
                                                                                                                          String context)
                                                                                                                   throws UGCException

Throws:

UGCException

getSortOrder

public static List<org.apache.commons.collections4.keyvalue.DefaultKeyValue<String,Boolean>> getSortOrder(List<String> sortFields,
                                                                                                          List<SocialSortOrder> sortOrder)

getStart

public static int getStart(int page,
                           int pageSize)