Class: Twilio::REST::Chat::V1::ServiceContext::ChannelInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Chat::V1::ServiceContext::ChannelInstance
- Defined in:
- lib/twilio-ruby/rest/chat/v1/service/channel.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Channel resource.
-
#attributes ⇒ String
The JSON string that stores application-specific data.
-
#context ⇒ ChannelContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#created_by ⇒ String
The ‘identity` of the User that created the channel.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the ChannelInstance.
-
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance
constructor
Initialize the ChannelInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#invites ⇒ invites
Access the invites.
-
#links ⇒ Hash
The absolute URLs of the [Members](www.twilio.com/docs/chat/api/members), [Messages](www.twilio.com/docs/chat/api/messages) , [Invites](www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](www.twilio.com/docs/chat/api/messages) for the Channel.
-
#members ⇒ members
Access the members.
-
#members_count ⇒ String
The number of Members in the Channel.
-
#messages ⇒ messages
Access the messages.
-
#messages_count ⇒ String
The number of Messages in the Channel.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the Channel resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
- #type ⇒ ChannelType
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance.
-
#url ⇒ String
The absolute URL of the Channel resource.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance
Initialize the ChannelInstance
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 343 def initialize(version, payload , service_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'friendly_name' => payload['friendly_name'], 'unique_name' => payload['unique_name'], 'attributes' => payload['attributes'], 'type' => payload['type'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'created_by' => payload['created_by'], 'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i, 'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i, 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Channel resource.
388 389 390 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 388 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
Returns The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.
412 413 414 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 412 def attributes @properties['attributes'] 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
373 374 375 376 377 378 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 373 def context unless @instance_context @instance_context = ChannelContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#created_by ⇒ String
Returns The ‘identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.
436 437 438 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 436 def created_by @properties['created_by'] end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
424 425 426 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 424 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 [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
430 431 432 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 430 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ChannelInstance
467 468 469 470 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 467 def delete context.delete end |
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance
475 476 477 478 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 475 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
400 401 402 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 400 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
529 530 531 532 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 529 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.ChannelInstance #{values}>" end |
#invites ⇒ invites
Access the invites
516 517 518 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 516 def invites context.invites end |
#links ⇒ Hash
Returns The absolute URLs of the [Members](www.twilio.com/docs/chat/api/members), [Messages](www.twilio.com/docs/chat/api/messages) , [Invites](www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](www.twilio.com/docs/chat/api/messages) for the Channel.
460 461 462 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 460 def links @properties['links'] end |
#members ⇒ members
Access the members
502 503 504 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 502 def members context.members end |
#members_count ⇒ String
Returns The number of Members in the Channel.
442 443 444 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 442 def members_count @properties['members_count'] end |
#messages ⇒ messages
Access the messages
509 510 511 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 509 def context. end |
#messages_count ⇒ String
Returns The number of Messages in the Channel.
448 449 450 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 448 def @properties['messages_count'] end |
#service_sid ⇒ String
Returns The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.
394 395 396 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 394 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Channel resource.
382 383 384 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 382 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
522 523 524 525 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 522 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.ChannelInstance #{values}>" end |
#type ⇒ ChannelType
418 419 420 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 418 def type @properties['type'] end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.
406 407 408 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 406 def unique_name @properties['unique_name'] end |
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 486 def update( friendly_name: :unset, unique_name: :unset, attributes: :unset ) context.update( friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, ) end |
#url ⇒ String
Returns The absolute URL of the Channel resource.
454 455 456 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 454 def url @properties['url'] end |