Class: Google::Apis::FcmV1::WebpushConfig

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

Overview

Webpush protocol options.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WebpushConfig

Returns a new instance of WebpushConfig.



804
805
806
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 804

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

Instance Attribute Details

#data ⇒ Hash<String,String>

Arbitrary key/value payload. If present, it will override google.firebase.fcm. v1.Message.data. Corresponds to the JSON property data

Returns:

  • (Hash<String,String>) 


782
783
784
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 782

def data
  @data
end

#fcm_options ⇒ Google::Apis::FcmV1::WebpushFcmOptions

Options for features provided by the FCM SDK for Web. Corresponds to the JSON property fcmOptions

Returns:



787
788
789
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 787

def fcm_options
  @fcm_options
end

#headers ⇒ Hash<String,String>

HTTP headers defined in webpush protocol. Refer to Webpush protocol for supported headers, e.g. "TTL": "15". Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


793
794
795
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 793

def headers
  @headers
end

#notification ⇒ Hash<String,Object>

Web Notification options as a JSON object. Supports Notification instance properties as defined in Web Notification API. If present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and [google.firebase.fcm. v1.Notification.body]. Corresponds to the JSON property notification

Returns:

  • (Hash<String,Object>) 


802
803
804
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 802

def notification
  @notification
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



809
810
811
812
813
814
 
# File 'lib/google/apis/fcm_v1/classes.rb', line 809

def update!(**args)
  @data = args[:data] if args.key?(:data)
  @fcm_options = args[:fcm_options] if args.key?(:fcm_options)
  @headers = args[:headers] if args.key?(:headers)
  @notification = args[:notification] if args.key?(:notification)
end