Interface IControllable

Namespace

Jabra.NET.Sdk.ButtonCustomization

Assembly

Jabra.NET.Sdk.ButtonCustomization.dll

Represents a control on the device that may have an associated LED that can be controlled.

public interface IControllable

Properties

IsOpen

Determines whether the controllable is currently open.

bool IsOpen { get; }

Property Value

bool

Methods

CloseAsync()

Release control of the controllable. Any configurations will be reset.

Task CloseAsync()

Returns

Task

A task that completes when the device has acknowledged release of control.

OpenAsync()

Opens the controllable for control. Any color or other customization previously set on the control by other functionality may be cleared.

Task OpenAsync()

Returns

Task

A task that completes on the successful opening of the control.

SetColorAsync(Color, LedMode?)

Set the color and mode of the LED associated with the controllable. If mode is not specified, the default mode is LedMode.On.

Task SetColorAsync(Color color, LedMode? mode = null)

Parameters

color Color

mode LedMode

Returns

Task

A task that completes when the color has been set on the device.

Exceptions

NotOpenForControlException

When the controllable has not been opened.

CustomizationFailedException

If setting the color fails. It could be because this controllable does not have an LED.