NetworkControlCommands
@Generated(value = ["GoogleHomePlatformCodegen"])
interface NetworkControlCommands
NetworkControl |
API for the NetworkControl trait. |
Summary
Public functions |
|
|---|---|
suspend Unit |
enableDisableGuestNetwork(enable: Boolean)Enables or disables the guest network. |
BatchableCommand<Unit> |
The batchable version of |
suspend Unit |
enableDisableNetworkProfile(enable: Boolean, networkProfileName: String)Enables or disables a network profile. |
BatchableCommand<Unit> |
enableDisableNetworkProfileBatchable(The batchable version of |
suspend NetworkControlTrait.GetGuestNetworkPasswordCommand.Response |
Gets the password of the guest network. |
BatchableCommand<NetworkControlTrait.GetGuestNetworkPasswordCommand.Response> |
The batchable version of |
suspend Unit |
testNetworkSpeed(testUploadSpeed: Boolean, testDownloadSpeed: Boolean)Tests the network's download and upload speed. |
BatchableCommand<Unit> |
testNetworkSpeedBatchable(The batchable version of |
Public functions
enableDisableGuestNetwork
suspend fun enableDisableGuestNetwork(enable: Boolean): Unit
Enables or disables the guest network. Secondary user verification with a PIN must be used. A user's home security can be affected if other security devices are disabled as a result of running this command.
| Parameters | |
|---|---|
enable: Boolean |
A value of |
enableDisableGuestNetworkBatchable
fun enableDisableGuestNetworkBatchable(enable: Boolean): BatchableCommand<Unit>
The batchable version of enableDisableGuestNetwork command.
Enables or disables the guest network. Secondary user verification with a PIN must be used. A user's home security can be affected if other security devices are disabled as a result of running this command.
| Parameters | |
|---|---|
enable: Boolean |
A value of |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
enableDisableNetworkProfile
suspend fun enableDisableNetworkProfile(enable: Boolean, networkProfileName: String): Unit
Enables or disables a network profile. Secondary user verification with a PIN must be used. A user's home security can be affected if other security devices are disabled as a result of running this command.
enableDisableNetworkProfileBatchable
fun enableDisableNetworkProfileBatchable(
enable: Boolean,
networkProfileName: String
): BatchableCommand<Unit>
The batchable version of enableDisableNetworkProfile command.
Enables or disables a network profile. Secondary user verification with a PIN must be used. A user's home security can be affected if other security devices are disabled as a result of running this command.
| Parameters | |
|---|---|
enable: Boolean |
A value of |
networkProfileName: String |
The profile name from the list of available profiles. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
getGuestNetworkPassword
suspend fun getGuestNetworkPassword(): NetworkControlTrait.GetGuestNetworkPasswordCommand.Response
Gets the password of the guest network.
getGuestNetworkPasswordBatchable
fun getGuestNetworkPasswordBatchable(): BatchableCommand<NetworkControlTrait.GetGuestNetworkPasswordCommand.Response>
The batchable version of getGuestNetworkPassword command.
Gets the password of the guest network.
| Returns | |
|---|---|
BatchableCommand<NetworkControlTrait.GetGuestNetworkPasswordCommand.Response> |
BatchableCommand |
testNetworkSpeed
suspend fun testNetworkSpeed(testUploadSpeed: Boolean, testDownloadSpeed: Boolean): Unit
Tests the network's download and upload speed.
testNetworkSpeedBatchable
fun testNetworkSpeedBatchable(
testUploadSpeed: Boolean,
testDownloadSpeed: Boolean
): BatchableCommand<Unit>
The batchable version of testNetworkSpeed command.
Tests the network's download and upload speed.
| Parameters | |
|---|---|
testUploadSpeed: Boolean |
Whether the upload speed should be tested. |
testDownloadSpeed: Boolean |
Whether the download speed should be tested. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |