Moodle 4.1 XRef and Diffs

Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Moodle 4.1 Database Schema (by Marcus Green)

/lib/google/src/Google/Service/ -> Proximitybeacon.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size:	1208 lines (38 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 26 classes

Google_Service_Proximitybeacon:: (1 method):
__construct()

Google_Service_Proximitybeacon_Beaconinfo_Resource:: (1 method):
getforobserved()

Google_Service_Proximitybeacon_Beacons_Resource:: (7 methods):
  activate()
  deactivate()
  decommission()
  get()
  listBeacons()
  register()
  update()

Google_Service_Proximitybeacon_BeaconsAttachments_Resource:: (4 methods):
  batchDelete()
  create()
  delete()
  listBeaconsAttachments()

Google_Service_Proximitybeacon_BeaconsDiagnostics_Resource:: (1 method):
listBeaconsDiagnostics()

Google_Service_Proximitybeacon_Namespaces_Resource:: (1 method):
listNamespaces()

Google_Service_Proximitybeacon_AdvertisedId:: (4 methods):
  setId()
  getId()
  setType()
  getType()

Google_Service_Proximitybeacon_AttachmentInfo:: (4 methods):
  setData()
  getData()
  setNamespacedType()
  getNamespacedType()

Google_Service_Proximitybeacon_Beacon:: (18 methods):
  setAdvertisedId()
  getAdvertisedId()
  setBeaconName()
  getBeaconName()
  setDescription()
  getDescription()
  setExpectedStability()
  getExpectedStability()
  setIndoorLevel()
  getIndoorLevel()
  setLatLng()
  getLatLng()
  setPlaceId()
  getPlaceId()
  setProperties()
  getProperties()
  setStatus()
  getStatus()

Google_Service_Proximitybeacon_BeaconAttachment:: (6 methods):
  setAttachmentName()
  getAttachmentName()
  setData()
  getData()
  setNamespacedType()
  getNamespacedType()

Google_Service_Proximitybeacon_BeaconInfo:: (8 methods):
  setAdvertisedId()
  getAdvertisedId()
  setAttachments()
  getAttachments()
  setBeaconName()
  getBeaconName()
  setDescription()
  getDescription()

Google_Service_Proximitybeacon_BeaconProperties:: (0 methods):

Google_Service_Proximitybeacon_Date:: (6 methods):
  setDay()
  getDay()
  setMonth()
  getMonth()
  setYear()
  getYear()

Google_Service_Proximitybeacon_DeleteAttachmentsResponse:: (2 methods):
setNumDeleted()
getNumDeleted()

Google_Service_Proximitybeacon_Diagnostics:: (6 methods):
  setAlerts()
  getAlerts()
  setBeaconName()
  getBeaconName()
  setEstimatedLowBatteryDate()
  getEstimatedLowBatteryDate()

Google_Service_Proximitybeacon_Empty:: (0 methods):

Google_Service_Proximitybeacon_GetInfoForObservedBeaconsRequest:: (4 methods):
  setNamespacedTypes()
  getNamespacedTypes()
  setObservations()
  getObservations()

Google_Service_Proximitybeacon_GetInfoForObservedBeaconsResponse:: (2 methods):
setBeacons()
getBeacons()

Google_Service_Proximitybeacon_IndoorLevel:: (2 methods):
setName()
getName()

Google_Service_Proximitybeacon_LatLng:: (4 methods):
  setLatitude()
  getLatitude()
  setLongitude()
  getLongitude()

Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse:: (2 methods):
setAttachments()
getAttachments()

Google_Service_Proximitybeacon_ListBeaconsResponse:: (6 methods):
  setBeacons()
  getBeacons()
  setNextPageToken()
  getNextPageToken()
  setTotalCount()
  getTotalCount()

Google_Service_Proximitybeacon_ListDiagnosticsResponse:: (4 methods):
  setDiagnostics()
  getDiagnostics()
  setNextPageToken()
  getNextPageToken()

Google_Service_Proximitybeacon_ListNamespacesResponse:: (2 methods):
setNamespaces()
getNamespaces()

Google_Service_Proximitybeacon_Observation:: (6 methods):
  setAdvertisedId()
  getAdvertisedId()
  setTelemetry()
  getTelemetry()
  setTimestampMs()
  getTimestampMs()

Google_Service_Proximitybeacon_ProximitybeaconNamespace:: (4 methods):
  setNamespaceName()
  getNamespaceName()
  setServingVisibility()
  getServingVisibility()

Class: Google_Service_Proximitybeacon - X-Ref

Service definition for Proximitybeacon (v1beta1).

<p>
This API provides services to register, manage, index, and search beacons.</p>

<p>
For more information about this service, see the API
<a href="https://developers.google.com/beacons/proximity/" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client) X-Ref

Constructs the internal representation of the Proximitybeacon service.

param: Google_Client $client

Class: Google_Service_Proximitybeacon_Beaconinfo_Resource - X-Ref

The "beaconinfo" collection of methods.
Typical usage is:
<code>
$proximitybeaconService = new Google_Service_Proximitybeacon(...);
$beaconinfo = $proximitybeaconService->beaconinfo;
</code>

getforobserved(Google_Service_Proximitybeacon_GetInfoForObservedBeaconsRequest $postBody, $optParams = array() X-Ref

Given one or more beacon observations, returns any beacon information and
attachments accessible to your application. (beaconinfo.getforobserved)

param: Google_GetInfoForObservedBeaconsRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_GetInfoForObservedBeaconsResponse

Class: Google_Service_Proximitybeacon_Beacons_Resource - X-Ref

The "beacons" collection of methods.
Typical usage is:
<code>
$proximitybeaconService = new Google_Service_Proximitybeacon(...);
$beacons = $proximitybeaconService->beacons;
</code>

activate($beaconName, $optParams = array() X-Ref

(Re)activates a beacon. A beacon that is active will return information and
attachment data when queried via `beaconinfo.getforobserved`. Calling this
method on an already active beacon will do nothing (but will return a
successful response code). (beacons.activate)

param: string $beaconName The beacon to activate. Required.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Empty

deactivate($beaconName, $optParams = array() X-Ref

Deactivates a beacon. Once deactivated, the API will not return information
nor attachment data for the beacon when queried via
`beaconinfo.getforobserved`. Calling this method on an already inactive
beacon will do nothing (but will return a successful response code).
(beacons.deactivate)

param: string $beaconName The beacon name of this beacon.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Empty

decommission($beaconName, $optParams = array() X-Ref

Decommissions the specified beacon in the service. This beacon will no longer
be returned from `beaconinfo.getforobserved`. This operation is permanent --
you will not be able to re-register a beacon with this ID again.
(beacons.decommission)

param: string $beaconName Beacon that should be decommissioned. Required.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Empty

get($beaconName, $optParams = array() X-Ref

Returns detailed information about the specified beacon. (beacons.get)

param: string $beaconName Beacon that is requested.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Beacon

listBeacons($optParams = array() X-Ref

Searches the beacon registry for beacons that match the given search
criteria. Only those beacons that the client has permission to list will be
returned. (beacons.listBeacons)

param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_ListBeaconsResponse

Registers a previously unregistered beacon given its `advertisedId`. These
IDs are unique within the system. An ID can be registered only once.
(beacons.register)

param: Google_Beacon $postBody
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Beacon

update($beaconName, Google_Service_Proximitybeacon_Beacon $postBody, $optParams = array() X-Ref

Updates the information about the specified beacon. **Any field that you do
not populate in the submitted beacon will be permanently erased**, so you
should follow the "read, modify, write" pattern to avoid inadvertently
destroying data. Changes to the beacon status via this method will be
silently ignored. To update beacon status, use the separate methods on this
API for (de)activation and decommissioning. (beacons.update)

param: string $beaconName Resource name of this beacon. A beacon name has the
param: Google_Beacon $postBody
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Beacon

Class: Google_Service_Proximitybeacon_BeaconsAttachments_Resource - X-Ref

The "attachments" collection of methods.
Typical usage is:
<code>
$proximitybeaconService = new Google_Service_Proximitybeacon(...);
$attachments = $proximitybeaconService->attachments;
</code>

batchDelete($beaconName, $optParams = array() X-Ref

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)

param: string $beaconName The beacon whose attachments are to be deleted.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_DeleteAttachmentsResponse

create($beaconName, Google_Service_Proximitybeacon_BeaconAttachment $postBody, $optParams = array() X-Ref

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)

param: string $beaconName The beacon on which the attachment should be
param: Google_BeaconAttachment $postBody
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_BeaconAttachment

delete($attachmentName, $optParams = array() X-Ref

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)

param: string $attachmentName The attachment name (`attachmentName`) of the
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_Empty

listBeaconsAttachments($beaconName, $optParams = array() X-Ref

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)

param: string $beaconName The beacon whose attachments are to be fetched.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_ListBeaconAttachmentsResponse

Class: Google_Service_Proximitybeacon_BeaconsDiagnostics_Resource - X-Ref

The "diagnostics" collection of methods.
Typical usage is:
<code>
$proximitybeaconService = new Google_Service_Proximitybeacon(...);
$diagnostics = $proximitybeaconService->diagnostics;
</code>

listBeaconsDiagnostics($beaconName, $optParams = array() X-Ref

List the diagnostics for a single beacon. You can also list diagnostics for
all the beacons owned by your Google Developers Console project by using the
beacon name `beacons/-`. (diagnostics.listBeaconsDiagnostics)

param: string $beaconName Beacon that the diagnostics are for.
param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_ListDiagnosticsResponse

Class: Google_Service_Proximitybeacon_Namespaces_Resource - X-Ref

The "namespaces" collection of methods.
Typical usage is:
<code>
$proximitybeaconService = new Google_Service_Proximitybeacon(...);
$namespaces = $proximitybeaconService->namespaces;
</code>

listNamespaces($optParams = array() X-Ref

Lists all attachment namespaces owned by your Google Developers Console
project. Attachment data associated with a beacon must include a namespaced
type, and the namespace must be owned by your project.
(namespaces.listNamespaces)

param: array $optParams Optional parameters.
return: Google_Service_Proximitybeacon_ListNamespacesResponse

Class: Google_Service_Proximitybeacon_AdvertisedId - X-Ref

setId($id) X-Ref

No description

getId() X-Ref

No description

setType($type) X-Ref

No description

getType() X-Ref

No description

Class: Google_Service_Proximitybeacon_AttachmentInfo - X-Ref

setData($data) X-Ref

No description