Class: Twilio::REST::Conversations::V1::ServiceContext::ConfigurationInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Conversations::V1::ServiceContext::ConfigurationInstance

Defined in:

lib/twilio-ruby/rest/conversations/v1/service/configuration.rb

Instance Method Summary

• #chat_service_sid ⇒ String

  The unique string that identifies the resource.

• #context ⇒ ConfigurationContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #default_chat_service_role_sid ⇒ String

  The service role assigned to users when they are added to the service.

• #default_conversation_creator_role_sid ⇒ String

  The role assigned to a conversation creator user when they join a new conversation.

• #default_conversation_role_sid ⇒ String

  The role assigned to users when they are added to a conversation.

• #fetch ⇒ ConfigurationInstance

  Fetch the ConfigurationInstance.

• #initialize(version, payload, chat_service_sid: nil) ⇒ ConfigurationInstance constructor

  Initialize the ConfigurationInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  Absolute URL to access the push notifications configuration of this service.

• #reachability_enabled ⇒ Boolean

  Whether the Reachability Indicator feature is enabled for this Conversations Service.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset) ⇒ ConfigurationInstance

  Update the ConfigurationInstance.

• #url ⇒ String

  An absolute URL for this service configuration.

Constructor Details

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

Initialize the ConfigurationInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 161

def initialize(version, payload, chat_service_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'chat_service_sid' => payload['chat_service_sid'],
      'default_conversation_creator_role_sid' => payload['default_conversation_creator_role_sid'],
      'default_conversation_role_sid' => payload['default_conversation_role_sid'],
      'default_chat_service_role_sid' => payload['default_chat_service_role_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
      'reachability_enabled' => payload['reachability_enabled'],
  }

  # Context
  @instance_context = nil
  @params = {'chat_service_sid' => chat_service_sid, }
end

Instance Method Details

#chat_service_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 193

def chat_service_sid
  @properties['chat_service_sid']
end

#context ⇒ ConfigurationContext

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

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 184

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

#default_chat_service_role_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 211

def default_chat_service_role_sid
  @properties['default_chat_service_role_sid']
end

#default_conversation_creator_role_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 199

def default_conversation_creator_role_sid
  @properties['default_conversation_creator_role_sid']
end

#default_conversation_role_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 205

def default_conversation_role_sid
  @properties['default_conversation_role_sid']
end

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 236

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 277

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

#links ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 223

def links
  @properties['links']
end

#reachability_enabled ⇒ Boolean

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 229

def reachability_enabled
  @properties['reachability_enabled']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 270

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

#update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 259

def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset)
  context.update(
      default_conversation_creator_role_sid: default_conversation_creator_role_sid,
      default_conversation_role_sid: default_conversation_role_sid,
      default_chat_service_role_sid: default_chat_service_role_sid,
      reachability_enabled: reachability_enabled,
  )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/configuration.rb', line 217

def url
  @properties['url']
end