Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Spectrum_Paws_Resource Class Reference

The "paws" collection of methods. More...

Inheritance diagram for Google_Service_Spectrum_Paws_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 getSpectrum (Google_Service_Spectrum_PawsGetSpectrumRequest $postBody, $optParams=array())
 Requests information about the available spectrum for a device at a location.
 
 getSpectrumBatch (Google_Service_Spectrum_PawsGetSpectrumBatchRequest $postBody, $optParams=array())
 The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.
 
 init (Google_Service_Spectrum_PawsInitRequest $postBody, $optParams=array())
 Initializes the connection between a white space device and the database.
 
 notifySpectrumUse (Google_Service_Spectrum_PawsNotifySpectrumUseRequest $postBody, $optParams=array())
 Notifies the database that the device has selected certain frequency ranges for transmission.
 
 register (Google_Service_Spectrum_PawsRegisterRequest $postBody, $optParams=array())
 The Google Spectrum Database implements registration in the getSpectrum method.
 
 verifyDevice (Google_Service_Spectrum_PawsVerifyDeviceRequest $postBody, $optParams=array())
 Validates a device for white space use in accordance with regulatory rules.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "paws" collection of methods.

Typical usage is: $spectrumService = new Google_Service_Spectrum(...); $paws = $spectrumService->paws;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ getSpectrum()

Google_Service_Spectrum_Paws_Resource::getSpectrum ( Google_Service_Spectrum_PawsGetSpectrumRequest $postBody,
$optParams = array() )

Requests information about the available spectrum for a device at a location.

Requests from a fixed-mode device must include owner information so the device can be registered with the database. (paws.getSpectrum)

Parameters
Google_PawsGetSpectrumRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsGetSpectrumResponse

◆ getSpectrumBatch()

Google_Service_Spectrum_Paws_Resource::getSpectrumBatch ( Google_Service_Spectrum_PawsGetSpectrumBatchRequest $postBody,
$optParams = array() )

The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.

(paws.getSpectrumBatch)

Parameters
Google_PawsGetSpectrumBatchRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsGetSpectrumBatchResponse

◆ init()

Google_Service_Spectrum_Paws_Resource::init ( Google_Service_Spectrum_PawsInitRequest $postBody,
$optParams = array() )

Initializes the connection between a white space device and the database.

(paws.init)

Parameters
Google_PawsInitRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsInitResponse

◆ notifySpectrumUse()

Google_Service_Spectrum_Paws_Resource::notifySpectrumUse ( Google_Service_Spectrum_PawsNotifySpectrumUseRequest $postBody,
$optParams = array() )

Notifies the database that the device has selected certain frequency ranges for transmission.

Only to be invoked when required by the regulator. The Google Spectrum Database does not operate in domains that require notification, so this always yields an UNIMPLEMENTED error. (paws.notifySpectrumUse)

Parameters
Google_PawsNotifySpectrumUseRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsNotifySpectrumUseResponse

◆ register()

Google_Service_Spectrum_Paws_Resource::register ( Google_Service_Spectrum_PawsRegisterRequest $postBody,
$optParams = array() )

The Google Spectrum Database implements registration in the getSpectrum method.

As such this always returns an UNIMPLEMENTED error. (paws.register)

Parameters
Google_PawsRegisterRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsRegisterResponse

◆ verifyDevice()

Google_Service_Spectrum_Paws_Resource::verifyDevice ( Google_Service_Spectrum_PawsVerifyDeviceRequest $postBody,
$optParams = array() )

Validates a device for white space use in accordance with regulatory rules.

The Google Spectrum Database does not support master/slave configurations, so this always yields an UNIMPLEMENTED error. (paws.verifyDevice)

Parameters
Google_PawsVerifyDeviceRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Spectrum_PawsVerifyDeviceResponse

The documentation for this class was generated from the following file: