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

  • account_sid (String) —

    The SID of the Account that created this UserBinding resource.

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

    The SID of the Call resource to fetch.



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

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  || @properties['service_sid']  ,'user_sid' => user_sid  || @properties['user_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the User Binding resource.

Returns:



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

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


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

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:



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

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](www.twilio.com/docs/chat/rest/credential-resource) for the binding. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more info.

Returns:



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

def credential_sid
    @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

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 [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserBindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the User Binding. The format of the value depends on the ‘binding_type`.

Returns:

  • (String) —

    The unique endpoint identifier for the User Binding. The format of the value depends on the ‘binding_type`.



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

def endpoint
    @properties['endpoint']
end

#fetch ⇒ UserBindingInstance

Fetch the UserBindingInstance

Returns:



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

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s [User](www.twilio.com/docs/chat/rest/user-resource) within the [Service](www.twilio.com/docs/chat/rest/service-resource). See [access tokens](www.twilio.com/docs/chat/create-tokens) for more info.

Returns:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.

Returns:



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

def message_types
    @properties['message_types']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the User Binding resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the User Binding resource.

Returns:

  • (String) —

    The unique string that we created to identify the User Binding resource.



281
282
283
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb', line 281

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def url
    @properties['url']
end

#user_sid ⇒ String

Returns The SID of the [User](www.twilio.com/docs/chat/rest/user-resource) with the User Binding resource. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more info.

Returns:



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

def user_sid
    @properties['user_sid']
end