Class: Twilio::REST::FlexApi::V1::ChannelInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::FlexApi::V1::ChannelInstance

Defined in:

lib/twilio-ruby/rest/flex_api/v1/channel.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource and owns this Workflow.

• #context ⇒ ChannelContext

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

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the Flex chat channel was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the Flex chat channel was last updated.

• #delete ⇒ Boolean

  Delete the ChannelInstance.

• #fetch ⇒ ChannelInstance

  Fetch the ChannelInstance.

• #flex_flow_sid ⇒ String

  The SID of the Flex Flow.

• #initialize(version, payload, sid: nil) ⇒ ChannelInstance constructor

  Initialize the ChannelInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  The unique string that identifies the resource.

• #task_sid ⇒ String

  The SID of the TaskRouter Task.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the Flex chat channel resource.

• #user_sid ⇒ String

  The SID of the chat user.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ChannelInstance

Initialize the ChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 230

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'flex_flow_sid' => payload['flex_flow_sid'],
      'sid' => payload['sid'],
      'user_sid' => payload['user_sid'],
      'task_sid' => payload['task_sid'],
      'url' => payload['url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 263

def account_sid
  @properties['account_sid']
end

#context ⇒ ChannelContext

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/flex_api/v1/channel.rb', line 254

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 299

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 305

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 319

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 312

def fetch
  context.fetch
end

#flex_flow_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 269

def flex_flow_sid
  @properties['flex_flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 332

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

#sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 275

def sid
  @properties['sid']
end

#task_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 287

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 325

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

#url ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 293

def url
  @properties['url']
end

#user_sid ⇒ String

# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 281

def user_sid
  @properties['user_sid']
end