Class PinboardPoster

    • Constructor Detail

      • PinboardPoster

        PinboardPoster(String apiToken)
        Creates a new instance using an API Token.
        Parameters:
        apiToken - The API token.
      • PinboardPoster

        PinboardPoster(Properties properties, String key)
        Creates a new instance using a Properties and Property Key.
        Parameters:
        properties - The properties.
        key - The property key.
      • PinboardPoster

        PinboardPoster(Properties properties)
        Creates a new instance using a Properties and Property Key.
        Parameters:
        properties - The properties.
      • PinboardPoster

        PinboardPoster(Path propertiesFilePath, String key)
        Creates a new instance using a Properties File Path and Property Key.
        Parameters:
        propertiesFilePath - The properties file path.
        key - The property key.
      • PinboardPoster

        PinboardPoster(Path propertiesFilePath)
        Creates a new instance using a Properties File Path and Property Key.
        Parameters:
        propertiesFilePath - The properties file path.
      • PinboardPoster

        PinboardPoster(File propertiesFile, String key)
        Creates a new instance using a Properties File and Property Key.
        Parameters:
        propertiesFile - The properties file.
        key - The property key.
      • PinboardPoster

        PinboardPoster(File propertiesFile)
        Creates a new instance using a Properties File and Property Key.
        Parameters:
        propertiesFile - The properties file.
      • PinboardPoster

        PinboardPoster()
        Creates a new instance.
    • Method Detail

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended, String tags, ZonedDateTime dt, Boolean replace, Boolean shared, Boolean toRead)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        tags - A list of up to 100 tags.
        dt - The creation time of the bookmark.
        replace - Replace any existing bookmark with the specified URL.
        shared - Make bookmark public.
        toRead - Mark the bookmark as unread.
        Returns:

        true if bookmark was successfully added.

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended, String tags, ZonedDateTime dt, Boolean replace, Boolean shared)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        tags - A list of up to 100 tags.
        dt - The creation time of the bookmark.
        replace - Replace any existing bookmark with the specified URL.
        shared - Make bookmark public.
        Returns:

        true if bookmark was successfully added.

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended, String tags, ZonedDateTime dt, Boolean replace)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        tags - A list of up to 100 tags.
        dt - The creation time of the bookmark.
        replace - Replace any existing bookmark with the specified URL.
        Returns:

        true if bookmark was successfully added.

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended, String tags, ZonedDateTime dt)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        tags - A list of up to 100 tags.
        dt - The creation time of the bookmark.
        Returns:

        true if bookmark was successfully added.

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended, String tags)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        tags - A list of up to 100 tags.
        Returns:

        true if bookmark was successfully added.

      • addPin

        @JvmOverloads() final Boolean addPin(String url, String description, String extended)

        Adds a bookmark to Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark.
        description - The title of the bookmark.
        extended - The description of the bookmark.
        Returns:

        true if bookmark was successfully added.

      • deletePin

         final Boolean deletePin(String url)

        Deletes a bookmark on Pinboard.

        This method supports of all the Pinboard API Parameters.

        Parameters:
        url - The URL of the bookmark to delete.
        Returns:

        true if bookmark was successfully deleted.