Class: Twilio::REST::Chat::V2::ServiceContext::UserContext::UserBindingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, user_sid: nil, sid: nil) ⇒ UserBindingInstance

Initialize the UserBindingInstance

Parameters:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 242

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'endpoint' => payload['endpoint'],
      'identity' => payload['identity'],
      'user_sid' => payload['user_sid'],
      'credential_sid' => payload['credential_sid'],
      'binding_type' => payload['binding_type'],
      'message_types' => payload['message_types'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this binding.

Returns:

  • (String) —

    The unique id of the Account responsible for this binding.



290
291
292
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 290

def 
  @properties['account_sid']
end

#binding_type ⇒ user_binding.BindingType

Returns The push technology to use for this binding.

Returns:

  • (user_binding.BindingType) —

    The push technology to use for this binding.



338
339
340
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 338

def binding_type
  @properties['binding_type']
end

#context ⇒ UserBindingContext

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

Returns:



270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 270

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

#credential_sid ⇒ String

Returns The unique id of the Credential for this binding.

Returns:

  • (String) —

    The unique id of the Credential for this binding.



332
333
334
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 332

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



302
303
304
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 302

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



308
309
310
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 308

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserBindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



364
365
366
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 364

def delete
  context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for this Binding.

Returns:

  • (String) —

    The unique endpoint identifier for this Binding.



314
315
316
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 314

def endpoint
  @properties['endpoint']
end

#fetch ⇒ UserBindingInstance

Fetch a UserBindingInstance

Returns:



357
358
359
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 357

def fetch
  context.fetch
end

#identity ⇒ String

Returns A unique string identifier for the Binding for this User in this Service.

Returns:

  • (String) —

    A unique string identifier for the Binding for this User in this Service.



320
321
322
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 320

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



377
378
379
380
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 377

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

#message_types ⇒ String

Returns List of message types for this binding.

Returns:

  • (String) —

    List of message types for this binding.



344
345
346
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 344

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

Returns The unique id of the Service this binding belongs to.

Returns:

  • (String) —

    The unique id of the Service this binding belongs to.



296
297
298
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 296

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



284
285
286
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 284

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



370
371
372
373
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 370

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

#url ⇒ String

Returns An absolute URL for this binding.

Returns:

  • (String) —

    An absolute URL for this binding.



350
351
352
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 350

def url
  @properties['url']
end

#user_sid ⇒ String

Returns The unique id of the User for this binding.

Returns:

  • (String) —

    The unique id of the User for this binding.



326
327
328
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 326

def user_sid
  @properties['user_sid']
end