Class: Twilio::REST::FlexApi::V1::WebChannelContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/web_channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ WebChannelContext

Initialize the WebChannelContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the WebChannel resource to update.



166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 166

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/WebChannels/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the WebChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



178
179
180
181
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 178

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ WebChannelInstance

Fetch the WebChannelInstance

Returns:



186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 186

def fetch

    payload = @version.fetch('GET', @uri)
    WebChannelInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



229
230
231
232
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 229

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

#to_s ⇒ Object

Provide a user friendly representation



222
223
224
225
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 222

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

#update(chat_status: :unset, post_engagement_data: :unset) ⇒ WebChannelInstance

Update the WebChannelInstance

Parameters:

  • chat_status (ChatStatus) (defaults to: :unset)
  • post_engagement_data (String) (defaults to: :unset) —

    The post-engagement data.

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 201

def update(
    chat_status: :unset, 
    post_engagement_data: :unset
)

    data = Twilio::Values.of({
        'ChatStatus' => chat_status,
        'PostEngagementData' => post_engagement_data,
    })

    payload = @version.update('POST', @uri, data: data)
    WebChannelInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end