Documentation

Google_Service_Spectrum_Resource_Paws extends Google_Service_Resource
in package

Application

The "paws" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
getSpectrum() : Google_Service_Spectrum_PawsGetSpectrumResponse: Requests information about the available spectrum for a device at a location.
getSpectrumBatch() : Google_Service_Spectrum_PawsGetSpectrumBatchResponse: The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error. (paws.getSpectrumBatch)
init() : Google_Service_Spectrum_PawsInitResponse: Initializes the connection between a white space device and the database.
notifySpectrumUse() : Google_Service_Spectrum_PawsNotifySpectrumUseResponse: 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.
register() : Google_Service_Spectrum_PawsRegisterResponse: The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error. (paws.register)
verifyDevice() : Google_Service_Spectrum_PawsVerifyDeviceResponse: Validates a device for white space use in accordance with regulatory rules.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

getSpectrum()

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


    public
                getSpectrum(Google_Service_Spectrum_PawsGetSpectrumRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsGetSpectrumResponse

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

Parameters

$postBody : Google_Service_Spectrum_PawsGetSpectrumRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsGetSpectrumResponse —

getSpectrumBatch()

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


    public
                getSpectrumBatch(Google_Service_Spectrum_PawsGetSpectrumBatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsGetSpectrumBatchResponse

Parameters

$postBody : Google_Service_Spectrum_PawsGetSpectrumBatchRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsGetSpectrumBatchResponse —

init()

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


    public
                init(Google_Service_Spectrum_PawsInitRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsInitResponse

(paws.init)

Parameters

$postBody : Google_Service_Spectrum_PawsInitRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsInitResponse —

notifySpectrumUse()

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.


    public
                notifySpectrumUse(Google_Service_Spectrum_PawsNotifySpectrumUseRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsNotifySpectrumUseResponse

(paws.notifySpectrumUse)

Parameters

$postBody : Google_Service_Spectrum_PawsNotifySpectrumUseRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsNotifySpectrumUseResponse —

register()

The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error. (paws.register)


    public
                register(Google_Service_Spectrum_PawsRegisterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsRegisterResponse

Parameters

$postBody : Google_Service_Spectrum_PawsRegisterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsRegisterResponse —

verifyDevice()

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


    public
                verifyDevice(Google_Service_Spectrum_PawsVerifyDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spectrum_PawsVerifyDeviceResponse

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

Parameters

$postBody : Google_Service_Spectrum_PawsVerifyDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spectrum_PawsVerifyDeviceResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —