PHP Class Phue\SoftwareUpdate

Show file Open project: sqmk/phue

Protected Properties

Property Type Description
$attributes stdClass Sofware Update attributes
$client Client Phue client

Public Methods

Method Description
__construct ( stdClass $attributes, Client $client ) Construct a Phue SoftwareUpdate object
checkForUpdate ( ) : self Check for update
checkingForUpdate ( ) : boolean Checking for update?
disableInstallNotification ( ) : self Disable the install notification
getReleaseNotesBrief ( ) : string Get release notes brief
getReleaseNotesUrl ( ) : string Get release notes URL
getUpdatableLights ( ) : array Get updatable lights
getUpdateState ( ) : integer Get update state
installUpdates ( ) : self Install updates
isBridgeUpdatable ( ) : boolean Is bridge updatable?
isInstallNotificationEnabled ( ) : boolean Is the install notification enabled?

Method Details

__construct() public method

Construct a Phue SoftwareUpdate object
public __construct ( stdClass $attributes, Client $client )
$attributes stdClass SoftwareUpdate attributes
$client Client Phue client

checkForUpdate() public method

Check for update
public checkForUpdate ( ) : self
return self This object

checkingForUpdate() public method

Checking for update?
public checkingForUpdate ( ) : boolean
return boolean True if checking, false if not

disableInstallNotification() public method

Disable the install notification
public disableInstallNotification ( ) : self
return self This object

getReleaseNotesBrief() public method

Get release notes brief
public getReleaseNotesBrief ( ) : string
return string Release notes

getReleaseNotesUrl() public method

Get release notes URL
public getReleaseNotesUrl ( ) : string
return string Release notes URL

getUpdatableLights() public method

Get updatable lights
public getUpdatableLights ( ) : array
return array List of updatable light ids

getUpdateState() public method

Get update state
public getUpdateState ( ) : integer
return integer Update state

installUpdates() public method

Install updates
public installUpdates ( ) : self
return self This object

isBridgeUpdatable() public method

Is bridge updatable?
public isBridgeUpdatable ( ) : boolean
return boolean True if updatable, false if not

isInstallNotificationEnabled() public method

Is the install notification enabled?
public isInstallNotificationEnabled ( ) : boolean
return boolean True if completed, false if not

Property Details

$attributes protected property

Sofware Update attributes
protected stdClass $attributes
return stdClass

$client protected property

Phue client
protected Client,phue $client
return Client