structures/inkapplications.shade.structures

Package-level declarations

Types

Link copied to clipboard
class ApiError(val code: Int, errors: List<String>) : ApiStatusError

Exception thrown if an error is received from the Hue API

Link copied to clipboard
open class ApiStatusError(val code: Int, message: String = "API Responded with code ") : ShadeException

Exception thrown if a status error is received from the Hue API

Link copied to clipboard
object AuthorizationTimeoutException : ShadeException

Thrown when the application has exceeded its limits of waiting for the user to press the authorize button on the Hue bridge.

Link copied to clipboard
data class AuthToken(val applicationKey: String, val clientKey: String? = null)

Wraps an API key used for authenticating with the Hue API

Link copied to clipboard
object HostnameNotSetException : UserError

Thrown to indicate that the SDK was used before setting a hostname for the bridge.

Link copied to clipboard
interface HueConfigurationContainer

Store configuration for communicating with the Hue API.

Link copied to clipboard
class InMemoryConfigurationContainer(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust) : HueConfigurationContainer

Implements a configuration container by storing config in a thread-safe memory storage structure.

Link copied to clipboard
open class InternalErrorException : ShadeException

Exception thrown if something within the Shade SDK has unexpectedly failed.

Link copied to clipboard
Link copied to clipboard
class NetworkException(message: String, cause: Throwable) : ShadeException

Exception thrown if an error occurs making API requests to the Hue API.

Link copied to clipboard
data class PowerInfo(val on: Boolean)

Describes the power state of a device and associated capabilities.

Link copied to clipboard
data class PowerValue(val on: Boolean)

Describes the power state of a device.

Link copied to clipboard
class PropertiesFileConfiguration(file: File = File( System.getProperty("user.home") .takeIf { it.isNullOrEmpty() == false }, ".shade-cli.properties" )) : HueConfigurationContainer

Load and save Hue configuration and authentication to a file.

Link copied to clipboard
@JvmInline
value class ResourceId(val value: String)

Unique identifier representing a specific resource instance.

Link copied to clipboard
data class ResourceReference(val id: ResourceId, val type: ResourceType)

A reference to another object in the API

Link copied to clipboard
@JvmInline
value class ResourceType(val key: String)

Discriminator key used within the hue api to determine object types

Link copied to clipboard
open class SecurityStrategy

Defines a strategy for handling SSL communication with the hue bridge.

Link copied to clipboard
@JvmInline
value class SegmentArchetype(val key: String)

Categorizes the type/purpose of the room/zone segment.

Link copied to clipboard
data class SegmentMetadata(val archetype: SegmentArchetype, val name: String)

Configuration data for a segment of devices, such as a room or zone.

Link copied to clipboard
data class SegmentMetadataUpdate(val archetype: SegmentArchetype? = null, val name: String? = null)

Configuration data for a segment of devices, such as a room or zone.@author

Link copied to clipboard
class SerializationError(message: String, cause: Throwable?) : InternalErrorException

Exception thrown if the SDK was unable to properly handle a response from the Hue API.

Link copied to clipboard
open class ShadeException : RuntimeException

Base/General class for all exceptions specific to shade.

Link copied to clipboard
class UnauthorizedException(cause: Throwable? = null) : ShadeException

Exception thrown when an application is unauthorized to perform the action.

Link copied to clipboard
annotation class UndocumentedApi

Annotation used to designate APIs in the hue system that were not documented.

Link copied to clipboard
class UnexpectedStateException(message: String, cause: Throwable? = null) : InternalErrorException

Exception thrown if an unexpected internal SDK state was reached.

Link copied to clipboard
data class UnknownEvent(val type: String, val json: String)

An event that was sent through the events api, but not deserialized by any module.

Link copied to clipboard
open class UserError : ShadeException

Thrown for errors that are caused by the user of the Shade SDK, typically a configuration error.

Link copied to clipboard
@JvmInline
value class VersionString(val full: String)

Software major/minor/patch version string.