org.craftercms.social.controllers.rest.v3.system

Class SocialContextController

java.lang.Object

org.craftercms.social.controllers.rest.v3.system.SocialContextController

@RequestMapping(value="/api/3/system/context")
@Controller
public class SocialContextController
extends Object

Constructor Summary

Constructors

Constructor and Description
SocialContextController()

Method Summary

Methods

Modifier and Type	Method and Description
org.craftercms.profile.api.Profile	addProfileToContext(String contextId, String profileId, String roles)
SocialContext	create(String contextName)
Iterable<SocialContext>	getAllContexts()
org.craftercms.profile.api.Profile	removeProfileFromContext(String contextId, String profileId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialContextController

public SocialContextController()

Method Detail

getAllContexts

@RequestMapping(value="/all",
                method=GET)
@ResponseBody
public Iterable<SocialContext> getAllContexts()
                                       throws SocialException

Throws:

SocialException

create

@RequestMapping(method=POST)
@ResponseBody
public SocialContext create(@RequestParam
                                               String contextName)
                     throws SocialException

Throws:

SocialException

addProfileToContext

@RequestMapping(value="/{id}/{profileId}",
                method=POST)
@ResponseBody
public org.craftercms.profile.api.Profile addProfileToContext(@PathVariable(value="id")
                                                                                 String contextId,
                                                                                 @PathVariable(value="profileId")
                                                                                 String profileId,
                                                                                 @RequestParam
                                                                                 String roles)
                                                       throws SocialException

Throws:

SocialException

removeProfileFromContext

@RequestMapping(value="/{id}/{profileId}",
                method=DELETE)
@ResponseBody
public org.craftercms.profile.api.Profile removeProfileFromContext(@PathVariable(value="id")
                                                                                      String contextId,
                                                                                      @PathVariable(value="profileId")
                                                                                      String profileId)
                                                            throws SocialException

Throws:

SocialException