# PreviewScreenshotParams

Artifact: [androidx.wear.watchface:watchface-editor](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/editor/WatchFaceEditorContract.kt+class:androidx.wear.watchface.editor.PreviewScreenshotParams) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***


```
public final class PreviewScreenshotParams
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Parameters for an optional final screenshot taken by `https://developer.android.com/reference/androidx/wear/watchface/editor/EditorSession` upon exit and reported via `https://developer.android.com/reference/androidx/wear/watchface/client/EditorState`.

use Watch Face Format instead

## Summary

| ### Public constructors |
|---|
| `[PreviewScreenshotParams](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#PreviewScreenshotParams(androidx.wear.watchface.RenderParameters,java.time.Instant))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters renderParameters, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html instant )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `boolean` | `[equals](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#equals(kotlin.Any))(https://developer.android.com/reference/java/lang/Object.html other)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html` | `[getInstant](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#getInstant())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters` | `[getRenderParameters](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#getRenderParameters())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `int` | `[hashCode](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#hashCode())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### PreviewScreenshotParams

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
public [PreviewScreenshotParams](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#PreviewScreenshotParams(androidx.wear.watchface.RenderParameters,java.time.Instant))(
    @NonNull RenderParameters renderParameters,
    @NonNull Instant instant
)
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters renderParameters` | The `https://developer.android.com/reference/androidx/wear/watchface/RenderParameters` to use when rendering the screen shot |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html instant` | The `https://developer.android.com/reference/java/time/Instant.html` to render with. |

## Public methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#equals(kotlin.Any))(Object other)
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

### getInstant

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
public final @NonNull Instant [getInstant](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#getInstant())()
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The `https://developer.android.com/reference/java/time/Instant.html` to render with.

### getRenderParameters

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
public final @NonNull RenderParameters [getRenderParameters](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#getRenderParameters())()
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The `https://developer.android.com/reference/androidx/wear/watchface/RenderParameters` to use when rendering the screen shot

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams#hashCode())()
```

> [!CAUTION]
> **This method is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff