Tenth MyTotalComfort Alert - TenthPres/MyTotalComfort GitHub Wiki

Tenth\MyTotalComfort\Alert

Class Alert

  • Class name: Alert
  • Namespace: Tenth\MyTotalComfort

Properties

$acknowledgable

protected mixed $acknowledgable = false
  • Visibility: protected

$dateTime

protected mixed $dateTime
  • Visibility: protected

$text

protected mixed $text
  • Visibility: protected

$id

protected mixed $id
  • Visibility: protected

$zone

protected mixed $zone
  • Visibility: protected

Methods

fromJsonString

array<mixed,\Tenth\MyTotalComfort\Alert> Tenth\MyTotalComfort\Alert::fromJsonString(string $jsonString, \Tenth\MyTotalComfort\Zone $zone)
  • Visibility: public
  • This method is static.

Arguments

Returns

  • array<mixed,\Tenth\MyTotalComfort\Alert> -

__get

mixed Tenth\MyTotalComfort\Alert::__get($what)
  • Visibility: public

Arguments

  • $what mixed

Returns

  • mixed

__construct

mixed Tenth\MyTotalComfort\Alert::__construct(array<mixed,string> $attributes, \Tenth\MyTotalComfort\Zone $zone)

Alert constructor.

  • Visibility: protected

Arguments

  • $attributes array<mixed,string> - Matches from the JSON status response
  • $zone Tenth\MyTotalComfort\Zone - The zone to which the alert belongs.

Returns

  • mixed

__toString

mixed Tenth\MyTotalComfort\Alert::__toString()
  • Visibility: public

Returns

  • mixed

acknowledge

mixed Tenth\MyTotalComfort\Alert::acknowledge()

Acknowledges and dismisses an alert, if the alert is able to be acknowledged and dismissed.

  • Visibility: public

Returns

  • mixed

acknowledgeSync

mixed Tenth\MyTotalComfort\Alert::acknowledgeSync()

Acknowledges and dismisses an alert synchronously, if the alert is able to be acknowledged and dismissed.

  • Visibility: public

Returns

  • mixed

acknowledgeInternal

null|\Psr\Http\Message\ResponseInterface Tenth\MyTotalComfort\Alert::acknowledgeInternal(boolean $sync)
  • Visibility: protected

Arguments

  • $sync boolean - Whether the Guzzle call should be synchronous.

Returns

  • null|\Psr\Http\Message\ResponseInterface -