UpdateStateRequest

public struct UpdateStateRequest : HTTPRequest

Update a device’s state.

This request can be used to update the device’s:

On/off status.
Brightness.
Hue.
Saturation.
Color temperature.

ResponseObject
Declaration
Swift

public typealias ResponseObject = Void
ErrorObject
Declaration
Swift

public typealias ErrorObject = APIError
baseURL
Declaration
Swift

public let baseURL: URL
method
Declaration
Swift

public var method: HTTPMethod { get }
path
Declaration
Swift

public var path: String { get }


                    
                    
                    isAuthenticated

Declaration

Swift

public var isAuthenticated: Bool { get }

body
Declaration
Swift

public var body: Data?

Initialization


                    
                    
                    init(url:token:isOn:brightness:hue:saturation:colorTemperature:)

Initialize a new instance.

Declaration

Swift

public init(
    url: URL,
    token: String,
    isOn: Bool? = nil,
    brightness: ValueMutation? = nil,
    hue: ValueMutation? = nil,
    saturation: ValueMutation? = nil,
    colorTemperature: ValueMutation? = nil
) throws

Parameters

`url`	The device’s URL.
`token`	The device’s token.
`isOn`	The on/off state.
`brightness`	The brightness mutation.
`hue`	The hue mutation.
`saturation`	The saturation mutation.
`colorTemperature`	The color temperature mutation.