Class: Google::Apis::FcmV1::Message

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

Overview

Message to send by Firebase Cloud Messaging Service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



674
675
676
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 674

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

Instance Attribute Details

#android ⇒ Google::Apis::FcmV1::AndroidConfig

Android specific options for messages sent through FCM connection server. Corresponds to the JSON property android

Returns:



624
625
626
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 624

def android
  @android
end

#apns ⇒ Google::Apis::FcmV1::ApnsConfig

Apple Push Notification Service specific options. Corresponds to the JSON property apns

Returns:



629
630
631
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 629

def apns
  @apns
end

#condition ⇒ String

Condition to send a message to, e.g. "'foo' in topics && 'bar' in topics". Corresponds to the JSON property condition

Returns:

  • (String) 


634
635
636
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 634

def condition
  @condition
end

#data ⇒ Hash<String,String>

Input only. Arbitrary key/value payload. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm"). Corresponds to the JSON property data

Returns:

  • (Hash<String,String>) 


640
641
642
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 640

def data
  @data
end

#fcm_options ⇒ Google::Apis::FcmV1::FcmOptions

Platform independent options for features provided by the FCM SDKs. Corresponds to the JSON property fcmOptions

Returns:



645
646
647
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 645

def fcm_options
  @fcm_options
end

#name ⇒ String

Output Only. The identifier of the message sent, in the format of projects/*/ messages/message_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


651
652
653
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 651

def name
  @name
end

#notification ⇒ Google::Apis::FcmV1::Notification

Basic notification template to use across all platforms. Corresponds to the JSON property notification

Returns:



656
657
658
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 656

def notification
  @notification
end

#token ⇒ String

Registration token to send a message to. Corresponds to the JSON property token

Returns:

  • (String) 


661
662
663
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 661

def token
  @token
end

#topic ⇒ String

Topic name to send a message to, e.g. "weather". Note: "/topics/" prefix should not be provided. Corresponds to the JSON property topic

Returns:

  • (String) 


667
668
669
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 667

def topic
  @topic
end

#webpush ⇒ Google::Apis::FcmV1::WebpushConfig

Webpush protocol options. Corresponds to the JSON property webpush

Returns:



672
673
674
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 672

def webpush
  @webpush
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'generated/google/apis/fcm_v1/classes.rb', line 679

def update!(**args)
  @android = args[:android] if args.key?(:android)
  @apns = args[:apns] if args.key?(:apns)
  @condition = args[:condition] if args.key?(:condition)
  @data = args[:data] if args.key?(:data)
  @fcm_options = args[:fcm_options] if args.key?(:fcm_options)
  @name = args[:name] if args.key?(:name)
  @notification = args[:notification] if args.key?(:notification)
  @token = args[:token] if args.key?(:token)
  @topic = args[:topic] if args.key?(:topic)
  @webpush = args[:webpush] if args.key?(:webpush)
end