Class: Twilio::REST::Conversations::V1::ServiceContext::BindingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::BindingInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/binding.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this binding.
- #binding_type ⇒ BindingType
-
#chat_service_sid ⇒ String
The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.
-
#context ⇒ BindingContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#credential_sid ⇒ String
The SID of the [Credential](www.twilio.com/docs/conversations/api/credential-resource) for the binding.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete ⇒ Boolean
Delete the BindingInstance.
-
#endpoint ⇒ String
The unique endpoint identifier for the Binding.
-
#fetch ⇒ BindingInstance
Fetch the BindingInstance.
-
#identity ⇒ String
The application-defined string that uniquely identifies the [Conversation User](www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource).
-
#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ BindingInstance
constructor
Initialize the BindingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#message_types ⇒ Array<String>
The [Conversation message types](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
An absolute API resource URL for this binding.
Constructor Details
#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ BindingInstance
Initialize the BindingInstance
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 235 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 || @properties['chat_service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this binding.
277 278 279 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 277 def account_sid @properties['account_sid'] end |
#binding_type ⇒ BindingType
319 320 321 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 319 def binding_type @properties['binding_type'] end |
#chat_service_sid ⇒ String
Returns The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.
283 284 285 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 283 def chat_service_sid @properties['chat_service_sid'] end |
#context ⇒ BindingContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
262 263 264 265 266 267 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 262 def context unless @instance_context @instance_context = BindingContext.new(@version , @params['chat_service_sid'], @params['sid']) end @instance_context end |
#credential_sid ⇒ String
Returns The SID of the [Credential](www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more info.
289 290 291 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 289 def credential_sid @properties['credential_sid'] end |
#date_created ⇒ Time
Returns The date that this resource was created.
295 296 297 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 295 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
301 302 303 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 301 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the BindingInstance
338 339 340 341 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 338 def delete context.delete end |
#endpoint ⇒ String
Returns The unique endpoint identifier for the Binding. The format of this value depends on the ‘binding_type`.
307 308 309 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 307 def endpoint @properties['endpoint'] end |
#fetch ⇒ BindingInstance
Fetch the BindingInstance
346 347 348 349 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 346 def fetch context.fetch end |
#identity ⇒ String
Returns The application-defined string that uniquely identifies the [Conversation User](www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource). See [access tokens](www.twilio.com/docs/conversations/create-tokens) for more info.
313 314 315 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 313 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
360 361 362 363 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 360 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.BindingInstance #{values}>" end |
#message_types ⇒ Array<String>
Returns The [Conversation message types](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.
325 326 327 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 325 def @properties['message_types'] end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
271 272 273 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 271 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
353 354 355 356 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 353 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.BindingInstance #{values}>" end |
#url ⇒ String
Returns An absolute API resource URL for this binding.
331 332 333 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 331 def url @properties['url'] end |