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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Chat::V2::ServiceContext::UserContext::UserBindingInstance

Defined in:

lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #binding_type ⇒ user_binding.BindingType

  The push technology to use for the binding.

• #context ⇒ UserBindingContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #credential_sid ⇒ String

  The SID of the Credential for the binding.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the UserBindingInstance.

• #endpoint ⇒ String

  The unique endpoint identifier for the User Binding.

• #fetch ⇒ UserBindingInstance

  Fetch the UserBindingInstance.

• #identity ⇒ String

  The string that identifies the resource’s User.

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

  Initialize the UserBindingInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #message_types ⇒ Array[String]

  The Programmable Chat message types the binding is subscribed to.

• #service_sid ⇒ String

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

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the User Binding resource.

• #user_sid ⇒ String

  The SID of the User with the binding.

Constructor Details

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

Initialize the UserBindingInstance

# 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

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

def account_sid
  @properties['account_sid']
end

#binding_type ⇒ user_binding.BindingType

# 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

# 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

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

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# 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

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

def delete
  context.delete
end

#endpoint ⇒ String

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

def endpoint
  @properties['endpoint']
end

#fetch ⇒ UserBindingInstance

Fetch the UserBindingInstance

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

def fetch
  context.fetch
end

#identity ⇒ String

# 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

# 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]

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

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# 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

# 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

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

def url
  @properties['url']
end

#user_sid ⇒ String

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

def user_sid
  @properties['user_sid']
end