Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: InteractionContext, InteractionInstance, InteractionList, InteractionPage, ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SessionContext

Initialize the SessionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the parent Service of the resource to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Session resource to fetch.



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 196

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

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

  # Dependents
  @interactions = nil
  @participants = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SessionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



220
221
222
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 220

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

#fetch ⇒ SessionInstance

Fetch the SessionInstance

Returns:



211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 211

def fetch
  payload = @version.fetch('GET', @uri)

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



299
300
301
302
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 299

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

#interactions(sid = :unset) ⇒ InteractionList, InteractionContext

Access the interactions

Returns:

Raises:

  • (ArgumentError) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 250

def interactions(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return InteractionContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @interactions
    @interactions = InteractionList.new(
        @version,
        service_sid: @solution[:service_sid],
        session_sid: @solution[:sid],
    )
  end

  @interactions
end

#participants(sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 272

def participants(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return ParticipantContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @participants
    @participants = ParticipantList.new(
        @version,
        service_sid: @solution[:service_sid],
        session_sid: @solution[:sid],
    )
  end

  @participants
end

#to_s ⇒ Object

Provide a user friendly representation



292
293
294
295
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 292

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

#update(date_expiry: :unset, ttl: :unset, status: :unset) ⇒ SessionInstance

Update the SessionInstance

Parameters:

  • date_expiry (Time) (defaults to: :unset) —

    The ISO 8601 date when the Session should expire. If this is value is present, it overrides the ‘ttl` value.

  • ttl (String) (defaults to: :unset) —

    The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session’s last Interaction.

  • status (session.Status) (defaults to: :unset) —

    The new status of the resource. Can be: ‘in-progress` to re-open a session or `closed` to close a session.

Returns:



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 234

def update(date_expiry: :unset, ttl: :unset, status: :unset)
  data = Twilio::Values.of({
      'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
      'Ttl' => ttl,
      'Status' => status,
  })

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

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