Package net.skinsrestorer.api.connections

Interface MineSkinAPI

public interface MineSkinAPI

Generate Value and Signature for a skin image url using the MineSkin API

Method Summary

Modifier and Type	Method	Description
default MineSkinResponse	genSkin(byte[] pngData, @Nullable SkinVariant skinVariant)	Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(byte[]) to convert a PNG byte array to a data URI.
default MineSkinResponse	genSkin(BufferedImage image, @Nullable SkinVariant skinVariant)	Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(BufferedImage) to convert a BufferedImage to a data URI.
default MineSkinResponse	genSkin(File file, @Nullable SkinVariant skinVariant)	Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(File) to convert a PNG file to a data URI.
MineSkinResponse	genSkin(String url, @Nullable SkinVariant skinVariant)	Generates a skin using the MineSkin API [WARNING] MineSkin api key might be REQUIRED in the future.
default MineSkinResponse	genSkin(Path file, @Nullable SkinVariant skinVariant)	Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(File) to convert a PNG file to a data URI.

Method Details

genSkin

MineSkinResponse genSkin(String url,
 @Nullable
 @Nullable SkinVariant skinVariant)
                  throws DataRequestException,
MineSkinException

Generates a skin using the MineSkin API [WARNING] MineSkin api key might be REQUIRED in the future.

Parameters:

url - pointing to a skin image url can be a direct link to a PNG file on a website or a data URI (data:image/png;base64,...) use Base64Utils.encodePNGAsUrl(byte[]) to convert a PNG file to a data URI

skinVariant - can be null, steve or slim

Returns:

Custom skin property containing "value" and "signature"

Throws:

DataRequestException - on error

MineSkinException - when there was a MineSkin specific error

genSkin

default MineSkinResponse genSkin(File file,
 @Nullable
 @Nullable SkinVariant skinVariant)
                          throws DataRequestException,
MineSkinException,
IOException

Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(File) to convert a PNG file to a data URI.

Parameters:

file - pointing to a PNG file

skinVariant - can be null, steve or slim

Returns:

Custom skin property containing "value" and "signature"

Throws:

DataRequestException - on error

MineSkinException - when there was a MineSkin specific error

IOException - if the file cannot be read

See Also:

• genSkin(String, SkinVariant)

genSkin

default MineSkinResponse genSkin(Path file,
 @Nullable
 @Nullable SkinVariant skinVariant)
                          throws DataRequestException,
MineSkinException,
IOException

Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(File) to convert a PNG file to a data URI.

Parameters:

file - pointing to a PNG file

skinVariant - can be null, steve or slim

Returns:

Custom skin property containing "value" and "signature"

Throws:

DataRequestException - on error

MineSkinException - when there was a MineSkin specific error

IOException - if the file cannot be read

See Also:

• genSkin(String, SkinVariant)

genSkin

default MineSkinResponse genSkin(BufferedImage image,
 @Nullable
 @Nullable SkinVariant skinVariant)
                          throws DataRequestException,
MineSkinException,
IOException

Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(BufferedImage) to convert a BufferedImage to a data URI.

Parameters:

image - BufferedImage of a PNG image

skinVariant - can be null, steve or slim

Returns:

Custom skin property containing "value" and "signature"

Throws:

DataRequestException - on error

MineSkinException - when there was a MineSkin specific error

IOException - if the image cannot be converted to PNG

See Also:

• genSkin(String, SkinVariant)

genSkin

default MineSkinResponse genSkin(byte[] pngData,
 @Nullable
 @Nullable SkinVariant skinVariant)
                          throws DataRequestException,
MineSkinException

Shorthand for genSkin(String, SkinVariant) with a call to Base64Utils.encodePNGAsUrl(byte[]) to convert a PNG byte array to a data URI.

Parameters:

pngData - byte array of a PNG image

skinVariant - can be null, steve or slim

Returns:

Custom skin property containing "value" and "signature"

Throws:

DataRequestException - on error

MineSkinException - when there was a MineSkin specific error

See Also:

• genSkin(String, SkinVariant)