Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::MemberInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MemberInstance

Initialize the MemberInstance



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 265

def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'channel_sid' => payload['channel_sid'],
      'service_sid' => payload['service_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'role_sid' => payload['role_sid'],
      'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
      'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'channel_sid' => channel_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String 



316
317
318
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 316

def 
  @properties['account_sid']
end

#channel_sid ⇒ String 



322
323
324
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 322

def channel_sid
  @properties['channel_sid']
end

#context ⇒ MemberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 296

def context
  unless @instance_context
    @instance_context = MemberContext.new(
        @version,
        @params['service_sid'],
        @params['channel_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time 



340
341
342
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 340

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



346
347
348
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 346

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MemberInstance



384
385
386
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 384

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch a MemberInstance



377
378
379
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 377

def fetch
  context.fetch
end

#identity ⇒ String 



334
335
336
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 334

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



406
407
408
409
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 406

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
end

#last_consumed_message_index ⇒ String 



358
359
360
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 358

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



364
365
366
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 364

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



352
353
354
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 352

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String 



328
329
330
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 328

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



310
311
312
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 310

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 399

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.IpMessaging.V1.MemberInstance #{values}>"
end

#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance

Update the MemberInstance



393
394
395
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 393

def update(role_sid: :unset, last_consumed_message_index: :unset)
  context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )
end

#url ⇒ String 



370
371
372
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 370

def url
  @properties['url']
end