C# Class Q42.HueApi.HueClient

Partial HueClient, contains requests to the /Groups/ url

Afficher le fichier Open project: Q42/Q42.HueApi Class Usage Examples

Méthodes publiques

Méthode	Description
CreateGroupAsync ( IEnumerable lights, string name = null, RoomClass roomClass = null ) : Task	Create a group for a list of lights
CreateScheduleAsync ( Schedule schedule ) : Task	Create a schedule
DeleteGroupAsync ( string groupId ) : Task	Deletes a single group
DeleteScheduleAsync ( string id ) : Task	Delete a schedule
DeleteWhiteListEntryAsync ( string entry ) : Task	Deletes a whitelist entry
GetBridgeAsync ( ) : Task	Get bridge info
GetCapabilitiesAsync ( ) : Task	Get bridge capabilities
GetConfigAsync ( ) : Task	Get bridge config
GetGroupAsync ( string id ) : Task	Get the state of a single group
GetGroupsAsync ( ) : Task>	Get all groups
GetScheduleAsync ( string id ) : Task	Get a single schedule
GetSchedulesAsync ( ) : Task>	Get all schedules
GetWhiteListAsync ( ) : Task>	Asynchronously gets the whitelist with the bridge.
SendGroupCommandAsync ( ICommandBody command, string group = "0" ) : Task	Send command to a group
UpdateBridgeConfigAsync ( Q42.HueApi.BridgeConfigUpdate update ) : Task	Update bridge config
UpdateGroupAsync ( string id, IEnumerable lights, string name = null ) : Task	Update a group
UpdateScheduleAsync ( string id, Schedule schedule ) : Task	Update a schedule

Private Methods

Méthode	Description
SendGroupCommandAsync ( string command, string group = "0" ) : Task	Send command to a group

Method Details

CreateGroupAsync() public méthode

Create a group for a list of lights

public CreateGroupAsync ( IEnumerable lights, string name = null, RoomClass roomClass = null ) : Task
lights	IEnumerable	List of lights in the group
name	string	Optional name
roomClass	RoomClass	for room creation the room class has to be passed, without class it will get the default: "Other" class.
Résultat	Task

CreateScheduleAsync() public méthode

Create a schedule

public CreateScheduleAsync ( Schedule schedule ) : Task
schedule	Q42.HueApi.Models.Schedule
Résultat	Task

DeleteGroupAsync() public méthode

Deletes a single group

public DeleteGroupAsync ( string groupId ) : Task
groupId	string
Résultat	Task

DeleteScheduleAsync() public méthode

Delete a schedule

public DeleteScheduleAsync ( string id ) : Task
id	string
Résultat	Task

DeleteWhiteListEntryAsync() public méthode

Deletes a whitelist entry

public DeleteWhiteListEntryAsync ( string entry ) : Task
entry	string
Résultat	Task

GetBridgeAsync() public méthode

Get bridge info

public GetBridgeAsync ( ) : Task
Résultat	Task

GetCapabilitiesAsync() public méthode

Get bridge capabilities

public GetCapabilitiesAsync ( ) : Task
Résultat	Task

GetConfigAsync() public méthode

Get bridge config

public GetConfigAsync ( ) : Task
Résultat	Task

GetGroupAsync() public méthode

Get the state of a single group

public GetGroupAsync ( string id ) : Task
id	string
Résultat	Task

GetGroupsAsync() public méthode

Get all groups

public GetGroupsAsync ( ) : Task>
Résultat	Task>

GetScheduleAsync() public méthode

Get a single schedule

public GetScheduleAsync ( string id ) : Task
id	string
Résultat	Task

GetSchedulesAsync() public méthode

Get all schedules

public GetSchedulesAsync ( ) : Task>
Résultat	Task>

GetWhiteListAsync() public méthode

Asynchronously gets the whitelist with the bridge.

public GetWhiteListAsync ( ) : Task>
Résultat	Task>

SendGroupCommandAsync() public méthode

Send command to a group

public SendGroupCommandAsync ( ICommandBody command, string group = "0" ) : Task
command	ICommandBody
group	string
Résultat	Task

UpdateBridgeConfigAsync() public méthode

Update bridge config

public UpdateBridgeConfigAsync ( Q42.HueApi.BridgeConfigUpdate update ) : Task
update	Q42.HueApi.BridgeConfigUpdate
Résultat	Task

UpdateGroupAsync() public méthode

Update a group

public UpdateGroupAsync ( string id, IEnumerable lights, string name = null ) : Task
id	string	Group ID
lights	IEnumerable	List of light IDs
name	string	Group Name
Résultat	Task

UpdateScheduleAsync() public méthode

Update a schedule

public UpdateScheduleAsync ( string id, Schedule schedule ) : Task
id	string
schedule	Q42.HueApi.Models.Schedule
Résultat	Task