SliceUtils.SerializeOptions

Kotlin |Java

public class SliceUtils.SerializeOptions

Holds options for how to handle SliceItems that cannot be serialized.

Summary

Constants
`static final int`	`MODE_CONVERT = 2` Constant indicating that the SliceItem should be serialized as much as possible.
`static final int`	`MODE_REMOVE = 1` Constant indicating that the SliceItem should be removed when this format is encountered.
`static final int`	`MODE_THROW = 0` Constant indicating that the an `IllegalArgumentException` should be thrown when this format is encountered.

Public constructors
`SerializeOptions()`

Public methods
`SliceUtils.SerializeOptions`	`setActionMode(int mode)` Sets how `FORMAT_ACTION` items should be handled.
`SliceUtils.SerializeOptions`	`setImageConversionFormat(Bitmap.CompressFormat format, int quality)` Sets the options to use when converting icons to be serialized.
`SliceUtils.SerializeOptions`	`setImageMode(int mode)` Sets how `FORMAT_IMAGE` items should be handled.
`SliceUtils.SerializeOptions`	`setMaxImageHeight(int height)` Set the maximum height of an image to use when serializing.
`SliceUtils.SerializeOptions`	`setMaxImageWidth(int width)` Set the maximum width of an image to use when serializing.

Constants

MODE_CONVERT

Added in 1.1.0-alpha02

public static final int MODE_CONVERT = 2

Constant indicating that the SliceItem should be serialized as much as possible.

For images this means they will be attempted to be serialized. For actions, the action will be removed but the content of the action will be serialized. The action may be triggered later on a de-serialized slice by binding the slice again and activating a pending-intent at the same location as the serialized action.

MODE_REMOVE

Added in 1.1.0-alpha02

public static final int MODE_REMOVE = 1

Constant indicating that the SliceItem should be removed when this format is encountered.

MODE_THROW

Added in 1.1.0-alpha02

public static final int MODE_THROW = 0

Constant indicating that the an IllegalArgumentException should be thrown when this format is encountered.

Public constructors

SerializeOptions

Added in 1.1.0-alpha02

public SerializeOptions()

Public methods

setActionMode

Added in 1.1.0-alpha02

public SliceUtils.SerializeOptions setActionMode(int mode)

Sets how FORMAT_ACTION items should be handled. The default mode is MODE_THROW.

Parameters
`int mode`	The desired mode.

setImageConversionFormat

Added in 1.1.0-alpha02

public SliceUtils.SerializeOptions setImageConversionFormat(Bitmap.CompressFormat format, int quality)

Sets the options to use when converting icons to be serialized. Only used if the image mode is set to MODE_CONVERT.

Parameters
`Bitmap.CompressFormat format`	The format to encode images with, default is `PNG`.
`int quality`	The quality to use when encoding images.

setImageMode

Added in 1.1.0-alpha02

public SliceUtils.SerializeOptions setImageMode(int mode)

Sets how FORMAT_IMAGE items should be handled. The default mode is MODE_THROW.

Parameters
`int mode`	The desired mode.

setMaxImageHeight

Added in 1.1.0-alpha02

public SliceUtils.SerializeOptions setMaxImageHeight(int height)

Set the maximum height of an image to use when serializing.

Will only be used if the setImageMode is set to MODE_CONVERT. Any images larger than the maximum size will be scaled down to fit within that size. The default value is 1000.

setMaxImageWidth

Added in 1.1.0-alpha02

public SliceUtils.SerializeOptions setMaxImageWidth(int width)

Set the maximum width of an image to use when serializing.

Will only be used if the setImageMode is set to MODE_CONVERT. Any images larger than the maximum size will be scaled down to fit within that size. The default value is 1000.