public interface ComponentService

Method Summary

Modifier and Type	Method	Description
`Component`	`createComponent(Component component)`
`void`	`createComponent(Component component, retrofit.Callback<Component> callback)`
`retrofit.client.Response`	`deleteComponent(String id)`
`void`	`deleteComponent(String id, retrofit.Callback<retrofit.client.Response> callback)`
`List<Component>`	`findComponentsByFields(Map<String,String> fields)`	Find components by one or more fields.
`List<Component>`	`findComponentsByFields(Map<String,String> fields, retrofit.Callback<Component> callback)`
`List<Component>`	`findComponentsInWorkspaceByName(String workspaceId, String name)`
`List<Component>`	`findComponentsInWorkspaceByName(String workspaceId, String name, retrofit.Callback<Component> callback)`
`List<Component>`	`getAllComponents()`
`void`	`getAllComponents(retrofit.Callback<List<Component>> callback)`
`Component`	`getComponentById(String id)`
`Component`	`getComponentById(String id, Map<String,String> queryParams)`
`void`	`getComponentById(String id, Map<String,String> queryParams, retrofit.Callback<Component> callback)`
`void`	`getComponentById(String id, retrofit.Callback<Component> callback)`
`Component`	`updateComponent(String id, Component component)`	Updates a component and returns a NEW immutable component.
`void`	`updateComponent(String id, Component component, retrofit.Callback<Component> callback)`

Method Details
- getAllComponents
  
  @GET("/api/component") List<Component> getAllComponents()
- getAllComponents
  
  @GET("/api/component") void getAllComponents(retrofit.Callback<List<Component>> callback)
- getComponentById
  
  @GET("/api/component/{id}") Component getComponentById(@Path("id") String id)
- getComponentById
  
  @GET("/api/component/{id}") void getComponentById(@Path("id") String id, retrofit.Callback<Component> callback)
- getComponentById
  
  @GET("/api/component/{id}") Component getComponentById(@Path("id") String id, @QueryMap Map<String,String> queryParams)
- getComponentById
  
  @GET("/api/component/{id}") void getComponentById(@Path("id") String id, @QueryMap Map<String,String> queryParams, retrofit.Callback<Component> callback)
- findComponentsByFields
  
  @GET("/api/component/fieldsearch") List<Component> findComponentsByFields(@QueryMap Map<String,String> fields)
  
  Find components by one or more fields. A field matches if the field equals the query (partial matches are not returned). If multiple fields are passed it will return components where all fields match.
  
  Parameters:
  
  fields - Map<String,String> fieldName -> expectedFieldValue
  
  Returns:
  
  list of components
- findComponentsByFields
  
  @GET("/api/component/fieldsearch") List<Component> findComponentsByFields(@QueryMap Map<String,String> fields, retrofit.Callback<Component> callback)
- findComponentsInWorkspaceByName
  
  @GET("/api/component/search") List<Component> findComponentsInWorkspaceByName(@Query("workspace") String workspaceId, @Query("name") String name)
- findComponentsInWorkspaceByName
  
  @GET("/api/component/search") List<Component> findComponentsInWorkspaceByName(@Query("workspace") String workspaceId, @Query("name") String name, retrofit.Callback<Component> callback)
- createComponent
  
  @POST("/api/component") Component createComponent(@Body Component component)
- createComponent
  
  @POST("/api/component") void createComponent(@Body Component component, retrofit.Callback<Component> callback)
- updateComponent
  
  @PUT("/api/component/{id}") Component updateComponent(@Path("id") String id, @Body Component component)
  
  Updates a component and returns a NEW immutable component.
  
  Parameters:
  
  id - The ID of the component to update
  
  component - The component's data that you wish to update
  
  Returns:
  
  updated and synced component
  
  See Also:
  
  Component
- updateComponent
  
  @PUT("/api/component/{id}") void updateComponent(@Path("id") String id, @Body Component component, retrofit.Callback<Component> callback)
- deleteComponent
  
  @DELETE("/api/component/{id}") retrofit.client.Response deleteComponent(@Path("id") String id)
- deleteComponent
  
  @DELETE("/api/component/{id}") void deleteComponent(@Path("id") String id, retrofit.Callback<retrofit.client.Response> callback)

Interface ComponentService

Method Summary

Method Details