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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 257

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 



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String 



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

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



288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 288

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 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MemberInstance



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

def delete
  context.delete
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance



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

def fetch
  context.fetch
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#last_consumed_message_index ⇒ String 



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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



302
303
304
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb', line 302

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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 



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

def url
  @properties['url']
end