Package pl.grizzlysoftware.dotykacka.client.v1.api.service

Interface TagService

  • public interface TagService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<Tag> createTag​(java.lang.Long cloudId, TagType tagType, Tag tag)  
      retrofit2.Call<Tag> getTag​(java.lang.Long cloudId, java.lang.Long tagId)  
      retrofit2.Call<java.util.Collection<Tag>> getTags​(java.lang.Long cloudId, int limit, int offset, java.lang.String sort)  

    • Method Detail

      • createTag

        @POST("{cloudId}/{tagType}/create")
retrofit2.Call<Tag> createTag​(@Path("cloudId")
                              java.lang.Long cloudId,
                              @Path("tagType")
                              TagType tagType,
                              @Body
                              Tag tag)
        Parameters:
        cloudId - - cloud id
        tagType - - type of the tag
        tag - - tag to be created
        Returns:

      • getTag

        @GET("{cloudId}/{tagId}")
retrofit2.Call<Tag> getTag​(@Path("cloudId")
                           java.lang.Long cloudId,
                           @Path("tagId")
                           java.lang.Long tagId)
        Parameters:
        cloudId - - cloud id
        tagId - - tag id
        Returns:

      • getTags

        @GET("{cloudId}")
retrofit2.Call<java.util.Collection<Tag>> getTags​(@Path("cloudId")
                                                  java.lang.Long cloudId,
                                                  @Query("limit")
                                                  int limit,
                                                  @Query("offset")
                                                  int offset,
                                                  @Query("sort")
                                                  java.lang.String sort)
        Parameters:
        cloudId - - cloud id
        offset - - pagination parameter, default = 0
        limit - - pagination parameter, default = 100, max = 100
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns: