Class: Twilio::REST::Conversations::V1::ServiceContext::ConfigurationContext::NotificationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::ConfigurationContext::NotificationInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the Account responsible for this configuration.
-
#added_to_conversation ⇒ Hash
The Push Notification configuration for being added to a Conversation.
-
#chat_service_sid ⇒ String
The SID of the Conversation Service that the Configuration applies to.
-
#context ⇒ NotificationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#fetch ⇒ NotificationInstance
Fetch the NotificationInstance.
-
#initialize(version, payload, chat_service_sid: nil) ⇒ NotificationInstance
constructor
Initialize the NotificationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#log_enabled ⇒ Boolean
Weather the notification logging is enabled.
-
#new_message ⇒ Hash
The Push Notification configuration for New Messages.
-
#removed_from_conversation ⇒ Hash
The Push Notification configuration for being removed from a Conversation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset, new_message_with_media_enabled: :unset, new_message_with_media_template: :unset) ⇒ NotificationInstance
Update the NotificationInstance.
-
#url ⇒ String
An absolute URL for this configuration.
Constructor Details
#initialize(version, payload, chat_service_sid: nil) ⇒ NotificationInstance
Initialize the NotificationInstance
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 171 def initialize(version, payload, chat_service_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'chat_service_sid' => payload['chat_service_sid'], 'new_message' => payload['new_message'], 'added_to_conversation' => payload['added_to_conversation'], 'removed_from_conversation' => payload['removed_from_conversation'], 'log_enabled' => payload['log_enabled'], 'url' => payload['url'], } # Context @instance_context = nil @params = {'chat_service_sid' => chat_service_sid, } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the Account responsible for this configuration.
203 204 205 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 203 def account_sid @properties['account_sid'] end |
#added_to_conversation ⇒ Hash
Returns The Push Notification configuration for being added to a Conversation.
221 222 223 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 221 def added_to_conversation @properties['added_to_conversation'] end |
#chat_service_sid ⇒ String
Returns The SID of the Conversation Service that the Configuration applies to.
209 210 211 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 209 def chat_service_sid @properties['chat_service_sid'] end |
#context ⇒ NotificationContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
194 195 196 197 198 199 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 194 def context unless @instance_context @instance_context = NotificationContext.new(@version, @params['chat_service_sid'], ) end @instance_context end |
#fetch ⇒ NotificationInstance
Fetch the NotificationInstance
300 301 302 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 300 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
313 314 315 316 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 313 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.NotificationInstance #{values}>" end |
#log_enabled ⇒ Boolean
Returns Weather the notification logging is enabled.
233 234 235 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 233 def log_enabled @properties['log_enabled'] end |
#new_message ⇒ Hash
Returns The Push Notification configuration for New Messages.
215 216 217 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 215 def @properties['new_message'] end |
#removed_from_conversation ⇒ Hash
Returns The Push Notification configuration for being removed from a Conversation.
227 228 229 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 227 def removed_from_conversation @properties['removed_from_conversation'] end |
#to_s ⇒ Object
Provide a user friendly representation
306 307 308 309 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 306 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.NotificationInstance #{values}>" end |
#update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset, new_message_with_media_enabled: :unset, new_message_with_media_template: :unset) ⇒ NotificationInstance
Update the NotificationInstance
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 279 def update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset, new_message_with_media_enabled: :unset, new_message_with_media_template: :unset) context.update( log_enabled: log_enabled, new_message_enabled: , new_message_template: , new_message_sound: , new_message_badge_count_enabled: , added_to_conversation_enabled: added_to_conversation_enabled, added_to_conversation_template: added_to_conversation_template, added_to_conversation_sound: added_to_conversation_sound, removed_from_conversation_enabled: removed_from_conversation_enabled, removed_from_conversation_template: removed_from_conversation_template, removed_from_conversation_sound: removed_from_conversation_sound, new_message_with_media_enabled: , new_message_with_media_template: , ) end |
#url ⇒ String
Returns An absolute URL for this configuration.
239 240 241 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 239 def url @properties['url'] end |