Google_Service_Proximitybeacon_BeaconsAttachments_Resource Class Reference

The "attachments" collection of methods. More...

Inheritance diagram for Google_Service_Proximitybeacon_BeaconsAttachments_Resource:

Public Member Functions
	batchDelete ($beaconName, $optParams=array())
	Deletes multiple attachments on a given beacon.
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create ($beaconName, Google_Service_Proximitybeacon_BeaconAttachment $postBody, $optParams=array())
	Associates the given data with the specified beacon.
	delete ($attachmentName, $optParams=array())
	Deletes the specified attachment for the given beacon.
	listBeaconsAttachments ($beaconName, $optParams=array())
	Returns the attachments for the specified beacon that match the specified namespaced-type pattern.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "attachments" collection of methods.

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

Member Function Documentation

batchDelete()

Google_Service_Proximitybeacon_BeaconsAttachments_Resource::batchDelete	(		$beaconName,
			$optParams = array() )

Deletes multiple attachments on a given beacon.

This operation is permanent and cannot be undone. 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. (attachments.batchDelete)

Parameters

string	$beaconName	The beacon whose attachments are to be deleted. Required.
array	$optParams	Optional parameters.

@opt_param string namespacedType Specifies the namespace and type of attachments to delete in namespace/type format. Accepts * to specify "all types in all namespaces". Optional.

Return values

Google_Service_Proximitybeacon_DeleteAttachmentsResponse

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

create()

Google_Service_Proximitybeacon_BeaconsAttachments_Resource::create	(		$beaconName,
		Google_Service_Proximitybeacon_BeaconAttachment	$postBody,
			$optParams = array() )

Associates the given data with the specified beacon.

Attachment data must contain two parts: - 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. (attachments.create)

Parameters

string	$beaconName	The beacon on which the attachment should be created. Required.
Google_BeaconAttachment	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Proximitybeacon_BeaconAttachment

delete()

Google_Service_Proximitybeacon_BeaconsAttachments_Resource::delete	(		$attachmentName,
			$optParams = array() )

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. (attachments.delete)

Parameters

string	$attachmentName	The attachment name (attachmentName) of the attachment to remove. For example: beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738 Required.
array	$optParams	Optional parameters.

Return values

Google_Service_Proximitybeacon_Empty

listBeaconsAttachments()

Google_Service_Proximitybeacon_BeaconsAttachments_Resource::listBeaconsAttachments	(		$beaconName,
			$optParams = array() )

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

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. (attachments.listBeaconsAttachments)

Parameters

string	$beaconName	The beacon whose attachments are to be fetched. Required.
array	$optParams	Optional parameters.

@opt_param string namespacedType Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts * to specify "all types in all namespaces".

Return values

Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse

---

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

• lib/google/src/Google/Service/Proximitybeacon.php