org.sonar.api.server.ws
Class WebService.NewAction

java.lang.Object
  extended by org.sonar.api.server.ws.WebService.NewAction
Enclosing interface:
WebService

public static class WebService.NewAction
extends Object


Method Summary
 WebService.NewParam createParam(String paramKey)
           
 WebService.NewAction createParam(String paramKey, String description)
          Deprecated. since 4.4. Use createParam(String paramKey) instead.
 WebService.NewAction setDeprecatedKey(String s)
           
 WebService.NewAction setDescription(String s)
           
 WebService.NewAction setHandler(RequestHandler h)
           
 WebService.NewAction setInternal(boolean b)
           
 WebService.NewAction setPost(boolean b)
           
 WebService.NewAction setResponseExample(URL url)
          Link to the document containing an example of response.
 WebService.NewAction setSince(String s)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setDeprecatedKey

public WebService.NewAction setDeprecatedKey(@Nullable
                                             String s)

setDescription

public WebService.NewAction setDescription(@Nullable
                                           String s)

setSince

public WebService.NewAction setSince(@Nullable
                                     String s)

setPost

public WebService.NewAction setPost(boolean b)

setInternal

public WebService.NewAction setInternal(boolean b)

setHandler

public WebService.NewAction setHandler(RequestHandler h)

setResponseExample

public WebService.NewAction setResponseExample(@Nullable
                                               URL url)
Link to the document containing an example of response. Content must be UTF-8 encoded.

Example:

   newAction.setResponseExample(getClass().getResource("/org/sonar/my-ws-response-example.json"));
 

Since:
4.4

createParam

public WebService.NewParam createParam(String paramKey)

createParam

@Deprecated
public WebService.NewAction createParam(String paramKey,
                                                   @Nullable
                                                   String description)
Deprecated. since 4.4. Use createParam(String paramKey) instead.



Copyright © 2009–2015 SonarSource. All rights reserved.