Class: Twilio::REST::Conversations::V1::ServiceContext::ConfigurationContext::NotificationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil) ⇒ NotificationInstance

Initialize the NotificationInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • chat_service_sid (String) (defaults to: nil)

    The unique string that we created to identify the Service configuration resource.


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 163

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_sidString

Returns The unique ID of the Account responsible for this configuration.

Returns:

  • (String)

    The unique ID of the Account responsible for this configuration.


195
196
197
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 195

def 
  @properties['account_sid']
end

#added_to_conversationHash

Returns The Push Notification configuration for being added to a Conversation.

Returns:

  • (Hash)

    The Push Notification configuration for being added to a Conversation.


213
214
215
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 213

def added_to_conversation
  @properties['added_to_conversation']
end

#chat_service_sidString

Returns The SID of the Conversation Service that the Configuration applies to.

Returns:

  • (String)

    The SID of the Conversation Service that the Configuration applies to.


201
202
203
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 201

def chat_service_sid
  @properties['chat_service_sid']
end

#contextNotificationContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


186
187
188
189
190
191
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 186

def context
  unless @instance_context
    @instance_context = NotificationContext.new(@version, @params['chat_service_sid'], )
  end
  @instance_context
end

#fetchNotificationInstance

Fetch the NotificationInstance

Returns:


284
285
286
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 284

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


297
298
299
300
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 297

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Conversations.V1.NotificationInstance #{values}>"
end

#log_enabledBoolean

Returns Weather the notification logging is enabled.

Returns:

  • (Boolean)

    Weather the notification logging is enabled.


225
226
227
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 225

def log_enabled
  @properties['log_enabled']
end

#new_messageHash

Returns The Push Notification configuration for New Messages.

Returns:

  • (Hash)

    The Push Notification configuration for New Messages.


207
208
209
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 207

def new_message
  @properties['new_message']
end

#removed_from_conversationHash

Returns The Push Notification configuration for being removed from a Conversation.

Returns:

  • (Hash)

    The Push Notification configuration for being removed from a Conversation.


219
220
221
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 219

def removed_from_conversation
  @properties['removed_from_conversation']
end

#to_sObject

Provide a user friendly representation


290
291
292
293
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 290

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) ⇒ NotificationInstance

Update the NotificationInstance

Parameters:

  • log_enabled (Boolean) (defaults to: :unset)

    Weather the notification logging is enabled.

  • new_message_enabled (Boolean) (defaults to: :unset)

    Whether to send a notification when a new message is added to a conversation. The default is `false`.

  • new_message_template (String) (defaults to: :unset)

    The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.

  • new_message_sound (String) (defaults to: :unset)

    The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.

  • new_message_badge_count_enabled (Boolean) (defaults to: :unset)

    Whether the new message badge is enabled. The default is `false`.

  • added_to_conversation_enabled (Boolean) (defaults to: :unset)

    Whether to send a notification when a participant is added to a conversation. The default is `false`.

  • added_to_conversation_template (String) (defaults to: :unset)

    The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.

  • added_to_conversation_sound (String) (defaults to: :unset)

    The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.

  • removed_from_conversation_enabled (Boolean) (defaults to: :unset)

    Whether to send a notification to a user when they are removed from a conversation. The default is `false`.

  • removed_from_conversation_template (String) (defaults to: :unset)

    The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.

  • removed_from_conversation_sound (String) (defaults to: :unset)

    The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.

Returns:


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 265

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)
  context.update(
      log_enabled: log_enabled,
      new_message_enabled: new_message_enabled,
      new_message_template: new_message_template,
      new_message_sound: new_message_sound,
      new_message_badge_count_enabled: 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,
  )
end

#urlString

Returns An absolute URL for this configuration.

Returns:

  • (String)

    An absolute URL for this configuration.


231
232
233
# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb', line 231

def url
  @properties['url']
end