com.samsung.android.penup

Class TagApi

  • java.lang.Object
    • com.samsung.android.penup.TagApi


  • public class TagApi
    extends java.lang.Object
    This class sends requests related to tag information added to artworks.
    Since:
    PEN.UP 1.0
    • Method Detail

      • getTag

        public static void getTag(PenupClient penupClient,
                  java.lang.String tagId,
                  ResourceCallback<TagResource> resourceCallback)
        Gets the tag with the specified ID.
        The Scope.READ_RESOURCES scope is required.
        Parameters:
        penupClient - The PenupClient instance
        tagId - The tag ID
        resourceCallback - The ResourceCallback instance for receiving the tag
        Throws:
        java.lang.IllegalArgumentException - Thrown when either of the following conditions has occurred:
        • The penupClient is null.
        • The tagId is null or empty.
        • The resourceListCallback is null.
        Since:
        PEN.UP 1.0
      • getAllTags

        public static void getAllTags(PenupClient penupClient,
                      int maxResults,
                      java.lang.String pageToken,
                      ResourceListCallback<TagResource> resourceListCallback)
        Gets all tags.
        The Scope.READ_RESOURCES scope is required.
        Parameters:
        penupClient - The PenupClient instance
        maxResults - The maximum number of tags to include in the response, which is used for paging.
        The value should be between 1 and 100.
        pageToken - The page token obtained from ResourceListCallback for getting the specific page.
        Sets null to get the first page.
        resourceListCallback - The ResourceListCallback instance for receiving all tags
        Throws:
        java.lang.IllegalArgumentException - Thrown when either of the following conditions has occurred:
        • The penupClient is null.
        • The maxResults is less than 1 or greater than 100.
        • The resourceListCallback is null.
        Since:
        PEN.UP 1.0
      • getMyFollowingTags

        public static void getMyFollowingTags(PenupClient penupClient,
                              int maxResults,
                              java.lang.String pageToken,
                              ResourceListCallback<TagResource> resourceListCallback)
        Gets tags which the user follows.
        The Scope.READ_MY_RESOURCES scope is required.
        Parameters:
        penupClient - The PenupClient instance
        maxResults - The maximum number of tags to include in the response, which is used for paging.
        The value should be between 1 and 100.
        pageToken - The page token obtained from ResourceListCallback for getting the specific page.
        Sets null to get the first page.
        resourceListCallback - The ResourceListCallback instance for receiving the tags which the user follows
        Throws:
        java.lang.IllegalArgumentException - Thrown when either of the following conditions has occurred:
        • The penupClient is null.
        • The maxResults is less than 1 or greater than 100.
        • The resourceListCallback is null.
        Since:
        PEN.UP 1.0