Documentation

Google_Service_Proximitybeacon_Resource_BeaconsAttachments extends Google_Service_Resource
in package

Application

The "attachments" collection of methods.

Typical usage is: $proximitybeaconService = new Google_Service_Proximitybeacon(...); $attachments = $proximitybeaconService->attachments;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
batchDelete() : Google_Service_Proximitybeacon_DeleteAttachmentsResponse: Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Proximitybeacon_BeaconAttachment: Associates the given data with the specified beacon. Attachment data must contain two parts:
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Proximitybeacon_ProximitybeaconEmpty: Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone.
listBeaconsAttachments() : Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse: Returns the attachments for the specified beacon that match the specified namespaced-type pattern.
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 —

batchDelete()

Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone.


    public
                batchDelete(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_DeleteAttachmentsResponse

You can optionally specify namespacedType to choose which attachments should be deleted. If you do not specify namespacedType, all your attachments on the given beacon will be deleted. You also may explicitly specify * to delete all.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (attachments.batchDelete)

Parameters

$beaconName : string: The beacon whose attachments should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are 3 for Eddystone-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Proximitybeacon_DeleteAttachmentsResponse —

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 —

create()

Associates the given data with the specified beacon. Attachment data must contain two parts:


    public
                create(string $beaconName, Google_Service_Proximitybeacon_BeaconAttachment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_BeaconAttachment

A namespaced type. The actual attachment data itself.

The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the namespaces endpoint, while the type can be a string of any characters except for the forward slash (/) up to 100 characters in length.

Attachment data can be up to 1024 bytes long.

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (attachments.create)

Parameters

$beaconName : string: Beacon on which the attachment should be created. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are 3 for Eddystone-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
$postBody : Google_Service_Proximitybeacon_BeaconAttachment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Proximitybeacon_BeaconAttachment —

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

delete()

Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone.


    public
                delete(string $attachmentName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ProximitybeaconEmpty

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (attachments.delete)

Parameters

$attachmentName : string: The attachment name (attachmentName) of the attachment to remove. For example: beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738. For Eddystone-EID beacons, the beacon ID portion (3!893737abc9) may be the beacon's current EID, or its "stable" Eddystone-UID. Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Proximitybeacon_ProximitybeaconEmpty —

listBeaconsAttachments()

Returns the attachments for the specified beacon that match the specified namespaced-type pattern.


    public
                listBeaconsAttachments(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse

To control which namespaced types are returned, you add the namespacedType query parameter to the request. You must either use *, to return all attachments, or the namespace must be one of the ones returned from the namespaces endpoint.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project. (attachments.listBeaconsAttachments)

Parameters

$beaconName : string: Beacon whose attachments should be fetched. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are 3 for Eddystone-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —