Class: Google::Apis::ProximitybeaconV1beta1::AttachmentInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/proximitybeacon_v1beta1/classes.rb,
generated/google/apis/proximitybeacon_v1beta1/representations.rb,
generated/google/apis/proximitybeacon_v1beta1/representations.rb

Overview

A subset of attachment information served via the beaconinfo.getforobserved method, used when your users encounter your beacons.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AttachmentInfo

Returns a new instance of AttachmentInfo.



91
92
93
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 91

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data ⇒ String

An opaque data container for client-provided data. Corresponds to the JSON property data NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


67
68
69
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 67

def data
  @data
end

#max_distance_meters ⇒ 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. Corresponds to the JSON property maxDistanceMeters

Returns:

  • (Float) 


82
83
84
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 82

def max_distance_meters
  @max_distance_meters
end

#namespaced_type ⇒ String

Specifies what kind of attachment this is. Tells a client how to interpret the data field. Format is namespace/type, for example scrupulous-wombat-12345/welcome-message Corresponds to the JSON property namespacedType

Returns:

  • (String) 


89
90
91
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 89

def namespaced_type
  @namespaced_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



96
97
98
99
100
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 96

def update!(**args)
  @data = args[:data] if args.key?(:data)
  @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters)
  @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type)
end