Class: Twilio::REST::Messaging::V1::SessionContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/session.rb,
lib/twilio-ruby/rest/messaging/v1/session/message.rb,
lib/twilio-ruby/rest/messaging/v1/session/webhook.rb,
lib/twilio-ruby/rest/messaging/v1/session/participant.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Defined Under Namespace

Classes: MessageContext, MessageInstance, MessageList, MessagePage, ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, WebhookContext, WebhookInstance, WebhookList, WebhookPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ SessionContext

Initialize the SessionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this resource.



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 191

def initialize(version, sid)
  super(version)

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

  # Dependents
  @participants = nil
  @messages = nil
  @webhooks = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the SessionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



222
223
224
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 222

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

#fetch ⇒ SessionInstance

Fetch a SessionInstance

Returns:



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 207

def fetch
  params = Twilio::Values.of({})

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



319
320
321
322
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 319

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

#messages(sid = :unset) ⇒ MessageList, MessageContext

Access the messages

Returns:

Raises:

  • (ArgumentError) 


278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 278

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

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

  unless @messages
    @messages = MessageList.new(@version, session_sid: @solution[:sid], )
  end

  @messages
end

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

Access the participants

Returns:

Raises:

  • (ArgumentError) 


260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 260

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

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

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

  @participants
end

#to_s ⇒ Object

Provide a user friendly representation



312
313
314
315
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 312

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

#update(friendly_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset) ⇒ SessionInstance

Update the SessionInstance

Parameters:

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

    The human-readable name of this session. Optional.

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

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set “{}” will be returned.

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

    The date that this resource was created.

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

    The date that this resource was last updated.

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

    Identity of the session’s creator. If the Session was created through the API, the value will be ‘system`

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 238

def update(friendly_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Attributes' => attributes,
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
      'CreatedBy' => created_by,
  })

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

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

#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext

Access the webhooks

Returns:

Raises:

  • (ArgumentError) 


296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/messaging/v1/session.rb', line 296

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

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

  unless @webhooks
    @webhooks = WebhookList.new(@version, session_sid: @solution[:sid], )
  end

  @webhooks
end