Class: Twilio::REST::Conversations::V1::ServiceContext::BindingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/binding.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ BindingInstance

Initialize the BindingInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • chat_service_sid (String) (defaults to: nil)

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

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this resource.


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/conversations/v1/service/binding.rb', line 248

def initialize(version, payload, chat_service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_sid'],
      'credential_sid' => payload['credential_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'],
      'binding_type' => payload['binding_type'],
      'message_types' => payload['message_types'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sidString

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/conversations/v1/service/binding.rb', line 290

def 
  @properties['account_sid']
end

#binding_typebinding.BindingType

Returns The push technology to use for the binding.

Returns:

  • (binding.BindingType)

    The push technology to use for the binding.


332
333
334
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 332

def binding_type
  @properties['binding_type']
end

#chat_service_sidString

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

Returns:

  • (String)

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


296
297
298
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 296

def chat_service_sid
  @properties['chat_service_sid']
end

#contextBindingContext

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
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 275

def context
  unless @instance_context
    @instance_context = BindingContext.new(@version, @params['chat_service_sid'], @params['sid'], )
  end
  @instance_context
end

#credential_sidString

Returns The SID of the Credential for the binding.

Returns:

  • (String)

    The SID of the Credential for the binding.


302
303
304
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 302

def credential_sid
  @properties['credential_sid']
end

#date_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created.


308
309
310
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 308

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated.

Returns:

  • (Time)

    The date that this resource was last updated.


314
315
316
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 314

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the BindingInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


351
352
353
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 351

def delete
  context.delete
end

#endpointString

Returns The unique endpoint identifier for the Binding.

Returns:

  • (String)

    The unique endpoint identifier for the Binding.


320
321
322
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 320

def endpoint
  @properties['endpoint']
end

#fetchBindingInstance

Fetch the BindingInstance

Returns:


358
359
360
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 358

def fetch
  context.fetch
end

#identityString

Returns The identity of Conversation User associated with this binding.

Returns:

  • (String)

    The identity of Conversation User associated with this binding.


326
327
328
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 326

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


371
372
373
374
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 371

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

#message_typesArray[String]

Returns The Conversation message types the binding is subscribed to.

Returns:

  • (Array[String])

    The Conversation message types the binding is subscribed to.


338
339
340
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 338

def message_types
  @properties['message_types']
end

#sidString

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/conversations/v1/service/binding.rb', line 284

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


364
365
366
367
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 364

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

#urlString

Returns An absolute URL for this binding.

Returns:

  • (String)

    An absolute URL for this binding.


344
345
346
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 344

def url
  @properties['url']
end