Class: Twilio::REST::Chat::V1::ServiceContext::ChannelContext::MemberInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Chat::V1::ServiceContext::ChannelContext::MemberInstance
- Defined in:
- lib/twilio-ruby/rest/chat/v1/service/channel/member.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Member resource.
-
#channel_sid ⇒ String
The unique ID of the [Channel](www.twilio.com/docs/api/chat/rest/channels) for the member.
-
#context ⇒ MemberContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the MemberInstance.
-
#fetch ⇒ MemberInstance
Fetch the MemberInstance.
-
#identity ⇒ String
The application-defined string that uniquely identifies the resource’s [User](www.twilio.com/docs/api/chat/rest/users) within the [Service](www.twilio.com/docs/api/chat/rest/services).
-
#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MemberInstance
constructor
Initialize the MemberInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#last_consumed_message_index ⇒ String
The index of the last [Message](www.twilio.com/docs/api/chat/rest/messages) in the [Channel](www.twilio.com/docs/api/chat/rest/channels) that the Member has read.
-
#last_consumption_timestamp ⇒ Time
The ISO 8601 timestamp string that represents the date-time of the last [Message](www.twilio.com/docs/api/chat/rest/messages) read event for the Member within the [Channel](www.twilio.com/docs/api/chat/rest/channels).
-
#role_sid ⇒ String
The SID of the [Role](www.twilio.com/docs/api/chat/rest/roles) assigned to the member.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the Member resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance
Update the MemberInstance.
-
#url ⇒ String
The absolute URL of the Member resource.
Constructor Details
#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ MemberInstance
Initialize the MemberInstance
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 279 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 || @properties['service_sid'] ,'channel_sid' => channel_sid || @properties['channel_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Member resource.
321 322 323 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 321 def account_sid @properties['account_sid'] end |
#channel_sid ⇒ String
Returns The unique ID of the [Channel](www.twilio.com/docs/api/chat/rest/channels) for the member.
327 328 329 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 327 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
306 307 308 309 310 311 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 306 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
Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
345 346 347 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 345 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
351 352 353 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 351 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the MemberInstance
382 383 384 385 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 382 def delete context.delete end |
#fetch ⇒ MemberInstance
Fetch the MemberInstance
390 391 392 393 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 390 def fetch context.fetch end |
#identity ⇒ String
Returns The application-defined string that uniquely identifies the resource’s [User](www.twilio.com/docs/api/chat/rest/users) within the [Service](www.twilio.com/docs/api/chat/rest/services). See [access tokens](www.twilio.com/docs/api/chat/guides/create-tokens) for more info.
339 340 341 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 339 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
420 421 422 423 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 420 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.MemberInstance #{values}>" end |
#last_consumed_message_index ⇒ String
Returns The index of the last [Message](www.twilio.com/docs/api/chat/rest/messages) in the [Channel](www.twilio.com/docs/api/chat/rest/channels) that the Member has read.
363 364 365 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 363 def @properties['last_consumed_message_index'] end |
#last_consumption_timestamp ⇒ Time
Returns The ISO 8601 timestamp string that represents the date-time of the last [Message](www.twilio.com/docs/api/chat/rest/messages) read event for the Member within the [Channel](www.twilio.com/docs/api/chat/rest/channels).
369 370 371 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 369 def @properties['last_consumption_timestamp'] end |
#role_sid ⇒ String
Returns The SID of the [Role](www.twilio.com/docs/api/chat/rest/roles) assigned to the member.
357 358 359 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 357 def role_sid @properties['role_sid'] end |
#service_sid ⇒ String
Returns The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.
333 334 335 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 333 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Member resource.
315 316 317 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 315 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
413 414 415 416 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 413 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.MemberInstance #{values}>" end |
#update(role_sid: :unset, last_consumed_message_index: :unset) ⇒ MemberInstance
Update the MemberInstance
400 401 402 403 404 405 406 407 408 409 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 400 def update( role_sid: :unset, last_consumed_message_index: :unset ) context.update( role_sid: role_sid, last_consumed_message_index: , ) end |
#url ⇒ String
Returns The absolute URL of the Member resource.
375 376 377 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/member.rb', line 375 def url @properties['url'] end |