Class: Google::Apis::FcmV1::Message
- Inherits:
-
Object
- Object
- Google::Apis::FcmV1::Message
- 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
-
#android ⇒ Google::Apis::FcmV1::AndroidConfig
Android specific options for messages sent through FCM connection server.
-
#apns ⇒ Google::Apis::FcmV1::ApnsConfig
Apple Push Notification Service specific options.
-
#condition ⇒ String
Condition to send a message to, e.g.
-
#data ⇒ Hash<String,String>
Input only.
-
#fcm_options ⇒ Google::Apis::FcmV1::FcmOptions
Platform independent options for features provided by the FCM SDKs.
-
#name ⇒ String
Output Only.
-
#notification ⇒ Google::Apis::FcmV1::Notification
Basic notification template to use across all platforms.
-
#token ⇒ String
Registration token to send a message to.
-
#topic ⇒ String
Topic name to send a message to, e.g.
-
#webpush ⇒ Google::Apis::FcmV1::WebpushConfig
Webpush protocol options.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Message
constructor
A new instance of Message.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Message
Returns a new instance of Message.
812 813 814 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 812 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
761 762 763 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 761 def android @android end |
#apns ⇒ Google::Apis::FcmV1::ApnsConfig
Apple Push Notification Service specific options.
Corresponds to the JSON property apns
766 767 768 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 766 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
772 773 774 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 772 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
778 779 780 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 778 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
783 784 785 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 783 def @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 property
name`
789 790 791 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 789 def name @name end |
#notification ⇒ Google::Apis::FcmV1::Notification
Basic notification template to use across all platforms.
Corresponds to the JSON property notification
794 795 796 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 794 def notification @notification end |
#token ⇒ String
Registration token to send a message to.
Corresponds to the JSON property token
799 800 801 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 799 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
805 806 807 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 805 def topic @topic end |
#webpush ⇒ Google::Apis::FcmV1::WebpushConfig
Webpush protocol options.
Corresponds to the JSON property webpush
810 811 812 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 810 def webpush @webpush end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
817 818 819 820 821 822 823 824 825 826 827 828 |
# File 'generated/google/apis/fcm_v1/classes.rb', line 817 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 |