Class: Twilio::REST::FlexApi::V1::WebChannelInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::FlexApi::V1::WebChannelInstance
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/web_channel.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow.
-
#context ⇒ WebChannelContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the WebChannelInstance.
-
#fetch ⇒ WebChannelInstance
Fetch the WebChannelInstance.
-
#flex_flow_sid ⇒ String
The SID of the Flex Flow.
-
#initialize(version, payload, sid: nil) ⇒ WebChannelInstance
constructor
Initialize the WebChannelInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#sid ⇒ String
The unique string that we created to identify the WebChannel resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(chat_status: :unset, post_engagement_data: :unset) ⇒ WebChannelInstance
Update the WebChannelInstance.
-
#url ⇒ String
The absolute URL of the WebChannel resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ WebChannelInstance
Initialize the WebChannelInstance
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 273 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'], '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
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow.
304 305 306 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 304 def account_sid @properties['account_sid'] end |
#context ⇒ WebChannelContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
295 296 297 298 299 300 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 295 def context unless @instance_context @instance_context = WebChannelContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
328 329 330 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 328 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
334 335 336 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 334 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the WebChannelInstance
341 342 343 344 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 341 def delete context.delete end |
#fetch ⇒ WebChannelInstance
Fetch the WebChannelInstance
349 350 351 352 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 349 def fetch context.fetch end |
#flex_flow_sid ⇒ String
Returns The SID of the Flex Flow.
310 311 312 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 310 def flex_flow_sid @properties['flex_flow_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
379 380 381 382 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 379 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.WebChannelInstance #{values}>" end |
#sid ⇒ String
Returns The unique string that we created to identify the WebChannel resource.
316 317 318 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 316 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
372 373 374 375 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 372 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.WebChannelInstance #{values}>" end |
#update(chat_status: :unset, post_engagement_data: :unset) ⇒ WebChannelInstance
Update the WebChannelInstance
359 360 361 362 363 364 365 366 367 368 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 359 def update( chat_status: :unset, post_engagement_data: :unset ) context.update( chat_status: chat_status, post_engagement_data: post_engagement_data, ) end |
#url ⇒ String
Returns The absolute URL of the WebChannel resource.
322 323 324 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 322 def url @properties['url'] end |