WatchFacePushManager.AddWatchFaceException

Artifact: androidx.wear.watchfacepush:watchfacepush

Kotlin |Java

public final class WatchFacePushManager.AddWatchFaceException extends Exception

java.lang.Object
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	androidx.wear.watchfacepush.WatchFacePushManager.AddWatchFaceException

An exception that can be thrown by addWatchFace

Summary

Constants
`static final int`	`ERROR_INVALID_PACKAGE_NAME` The package name of the watch face is invalid.
`static final int`	`ERROR_INVALID_VALIDATION_TOKEN` The validation token provided does not match the watch face.
`static final int`	`ERROR_MALFORMED_WATCHFACE_APK` The provided watch face is not a valid Android APK.
`static final int`	`ERROR_SLOT_LIMIT_REACHED` The limit of watch faces that can be installed by this application has been reached.
`static final int`	`ERROR_UNEXPECTED_CONTENT` Unexpected content in the APK.
`static final int`	`ERROR_UNKNOWN` Unknown error while adding a watch face.

Public constructors
`AddWatchFaceException(int errorCode, @NonNull Throwable rootCause)`

Public methods
`final int`	`getErrorCode()` The specific subtype of error occurred.
`String`	`getMessage()`

Inherited methods

From kotlin.Throwable

`final void`	`addSuppressed(@RecentlyNonNull @NonNull Throwable p0)`
`@NonNull Throwable`	`@RecentlyNonNull fillInStackTrace()`
`Throwable`	`getCause()`
`@NonNull String`	`@RecentlyNullable getLocalizedMessage()`
`@NonNull StackTraceElement[]`	`@RecentlyNonNull getStackTrace()`
`final @NonNull Throwable[]`	`@RecentlyNonNull getSuppressed()`
`@NonNull Throwable`	`@RecentlyNonNull initCause(@RecentlyNullable @NonNull Throwable p0)`
`void`	`printStackTrace()`
`void`	`printStackTrace(@RecentlyNonNull @NonNull PrintStream p0)`
`void`	`printStackTrace(@RecentlyNonNull @NonNull PrintWriter p0)`
`void`	`setStackTrace(@RecentlyNonNull @NonNull StackTraceElement[] p0)`

Constants

ERROR_INVALID_PACKAGE_NAME

public static final int ERROR_INVALID_PACKAGE_NAME

The package name of the watch face is invalid.

The package name of the watch face must start with the package name of the Watch Face Push client, followed by the 'watchfacepush' keyword, ending with the unique watch face name. Developers should verify that the package name follows this format.

ERROR_INVALID_VALIDATION_TOKEN

public static final int ERROR_INVALID_VALIDATION_TOKEN

The validation token provided does not match the watch face.

Developers should see the Watch Face Push documentation to see how to generate a validation token correctly.

ERROR_MALFORMED_WATCHFACE_APK

public static final int ERROR_MALFORMED_WATCHFACE_APK

The provided watch face is not a valid Android APK.

Developers should ensure that the provided file is a valid APK file.

ERROR_SLOT_LIMIT_REACHED

public static final int ERROR_SLOT_LIMIT_REACHED

The limit of watch faces that can be installed by this application has been reached.

No more watch faces can be added. Developers should instruct the user to remove existing watch faces added by this app before attempting to add new ones.

ERROR_UNEXPECTED_CONTENT

public static final int ERROR_UNEXPECTED_CONTENT

Unexpected content in the APK.

The APK must be a WFF watchface which only contains the watchface XML file and the associated resources. The APK can't contain any executable code. Developers should ensure that the APK conforms to the Watch Face Format.

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

Unknown error while adding a watch face.

This typically means that the Watch Face Push service on the watch could not be accessed or that the watch may be in a bad state.

Public constructors

AddWatchFaceException

Added in 1.0.0-alpha01

public AddWatchFaceException(int errorCode, @NonNull Throwable rootCause)

Parameters
`int errorCode`	The specific subtype of error occurred. See `ErrorCode` for the possible values.
`@NonNull Throwable rootCause`	The exception that caused the problem in the first place.

Public methods

getErrorCode

Added in 1.0.0-alpha01

public final int getErrorCode()

The specific subtype of error occurred. See ErrorCode for the possible values.

getMessage

public String getMessage()