google_api_proximity_beacon v0.2.0 GoogleApi.ProximityBeacon.V1beta1.Model.BeaconAttachment View Source

Project-specific data associated with a beacon.

Attributes

  • attachmentName (String.t): Resource name of this attachment. Attachment names have the format: <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>. Leave this empty on creation. Defaults to: null.
  • creationTimeMs (DateTime.t): The UTC time when this attachment was created, in milliseconds since the UNIX epoch. Defaults to: null.
  • data (binary()): An opaque data container for client-provided data. Must be base64 encoded in HTTP requests, and will be so encoded (with padding) in responses. Required. Defaults to: null.
  • maxDistanceMeters (float()): The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. Negative values are invalid and return an error. Defaults to: null.
  • namespacedType (String.t): Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.ProximityBeacon.V1beta1.Model.BeaconAttachment{
  attachmentName: any(),
  creationTimeMs: DateTime.t(),
  data: any(),
  maxDistanceMeters: any(),
  namespacedType: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.