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:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The SID of the Service the User Binding resource is associated with.

  • user_sid (String) (defaults to: nil) —

    The SID of the User with the User Binding resource. See push notification configuration for more info.

  • sid (String) (defaults to: nil) —

    The SID of the User Binding resource to fetch.


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 247

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#binding_type ⇒ user_binding.BindingType

Returns The push technology to use for the binding.

Returns:

  • (user_binding.BindingType) —

    The push technology to use for the binding


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

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:


275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 275

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 SID of the Credential for the binding.

Returns:

  • (String) —

    The SID of the Credential for the binding


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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserBindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the User Binding.

Returns:

  • (String) —

    The unique endpoint identifier for the User Binding


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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ UserBindingInstance

Fetch the UserBindingInstance

Returns:


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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The string that identifies the resource's User.

Returns:

  • (String) —

    The string that identifies the resource's User


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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


382
383
384
385
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 382

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

#message_types ⇒ Array[String]

Returns The Programmable Chat message types the binding is subscribed to.

Returns:

  • (Array[String]) —

    The Programmable Chat message types the binding is subscribed to


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

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with


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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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

#url ⇒ String

Returns The absolute URL of the User Binding resource.

Returns:

  • (String) —

    The absolute URL of the User Binding resource


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

def url
  @properties['url']
end

#user_sid ⇒ String

Returns The SID of the User with the binding.

Returns:

  • (String) —

    The SID of the User with the binding


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

def user_sid
  @properties['user_sid']
end