Interface PublishProfile

All Known Subinterfaces:
MutablePublishProfile

public interface PublishProfile
A publish profile contains information for a specific publish service. This class is a simple holder for a blob with a type, title, and description. The profile data is interpreted by the service it is handled to. Note that this interface is read-only. A profile that can be edited should implement MutablePublishProfile.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the description of the profile.
    byte[]
    Returns the profile data.
    Return the title of the profile.
    Returns the type of the profile.
  • Method Details

    • getType

      String getType()
      Returns the type of the profile. This should be a unique identifier identifying the module used to create the custom export profile.
      Returns:
      The profile type.
      Since:
      3.2
    • getTitle

      String getTitle()
      Return the title of the profile.
      Returns:
      The profile title.
      Since:
      3.2
    • getDescription

      String getDescription()
      Returns the description of the profile.
      Returns:
      The profile description.
      Since:
      3.2
    • getProfileData

      byte[] getProfileData() throws IOException
      Returns the profile data. Note that this method may block for a while.
      Returns:
      The profiles data.
      Throws:
      IOException - If an IOException occurs.
      Since:
      3.2