google_api_proximity_beacon v0.7.0 GoogleApi.ProximityBeacon.V1beta1.Model.BeaconAttachment View Source
Project-specific data associated with a beacon.
Attributes
attachmentName
(type:String.t
, default:nil
) - Resource name of this attachment. Attachment names have the format:beacons/beacon_id/attachments/attachment_id
. Leave this empty on creation.creationTimeMs
(type:DateTime.t
, default:nil
) - The UTC time when this attachment was created, in milliseconds since the UNIX epoch.data
(type:String.t
, default:nil
) - 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.maxDistanceMeters
(type:float()
, default:nil
) - 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.
namespacedType
(type:String.t
, default:nil
) - Specifies what kind of attachment this is. Tells a client how to interpret thedata
field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type ofdata
, for use by the client when parsing thedata
field. Required.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Sourcet() :: %GoogleApi.ProximityBeacon.V1beta1.Model.BeaconAttachment{ attachmentName: String.t(), creationTimeMs: DateTime.t(), data: String.t(), maxDistanceMeters: float(), namespacedType: String.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.