Class: Twilio::REST::Chat::V3::ChannelContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/chat/v3/channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ ChannelContext

Initialize the ChannelContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The unique SID identifier of the Service.

  • sid (String)

    A 34 character string that uniquely identifies this Channel.


68
69
70
71
72
73
74
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 68

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
end

Instance Method Details

#inspectObject

Provide a detailed, user friendly representation


103
104
105
106
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 103

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Chat.V3.ChannelContext #{context}>"
end

#to_sObject

Provide a user friendly representation


96
97
98
99
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 96

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Chat.V3.ChannelContext #{context}>"
end

#update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance

Parameters:

  • type (channel.ChannelType) (defaults to: :unset)

    TThe Type for this Channel to migrate to. Can only be `private`. Migration to 'public' is not allowed.

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

    The unique ID of the Messaging Service this channel belongs to.

  • x_twilio_webhook_enabled (channel.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


85
86
87
88
89
90
91
92
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 85

def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({'Type' => type, 'MessagingServiceSid' => messaging_service_sid, })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

  payload = @version.update('POST', @uri, data: data, headers: headers)

  ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end