WatchFacePushManager.AddWatchFaceException

Artifact: androidx.wear.watchfacepush:watchfacepush

Kotlin |Java

class WatchFacePushManager.AddWatchFaceException : Exception

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

An exception that can be thrown by addWatchFace

Summary

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

Public constructors
`AddWatchFaceException(errorCode: Int, rootCause: Throwable)`

Public properties
`Int`	`errorCode` The specific subtype of error occurred.
`open String?`	`message`

Inherited functions

From kotlin.Throwable

`Unit`	`addSuppressed(@RecentlyNonNull p0: Throwable)`
`open Throwable`	`@RecentlyNonNull fillInStackTrace()`
`open String`	`@RecentlyNullable getLocalizedMessage()`
`open Array<StackTraceElement>`	`@RecentlyNonNull getStackTrace()`
`Array<Throwable>`	`@RecentlyNonNull getSuppressed()`
`open Throwable`	`@RecentlyNonNull initCause(@RecentlyNullable p0: Throwable)`
`open Unit`	`printStackTrace()`
`open Unit`	`printStackTrace(@RecentlyNonNull p0: PrintStream)`
`open Unit`	`printStackTrace(@RecentlyNonNull p0: PrintWriter)`
`open Unit`	`setStackTrace(@RecentlyNonNull p0: Array<StackTraceElement>)`

Inherited properties

From kotlin.Throwable

open Throwable?

cause

Constants

ERROR_INVALID_PACKAGE_NAME

const val ERROR_INVALID_PACKAGE_NAME: Int

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

const val ERROR_INVALID_VALIDATION_TOKEN: Int

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

const val ERROR_MALFORMED_WATCHFACE_APK: Int

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

const val ERROR_SLOT_LIMIT_REACHED: Int

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

const val ERROR_UNEXPECTED_CONTENT: Int

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

const val ERROR_UNKNOWN: Int

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

AddWatchFaceException(errorCode: Int, rootCause: Throwable)

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

Public properties

errorCode

Added in 1.0.0-alpha01

val errorCode: Int

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

message

open val message: String?