Class: Twilio::REST::Chat::V2::ServiceContext::BindingInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Chat::V2::ServiceContext::BindingInstance
- Defined in:
- lib/twilio-ruby/rest/chat/v2/service/binding.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Binding resource.
- #binding_type ⇒ BindingType
-
#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/chat/rest/credential-resource) for the binding.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#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 resource’s [User](www.twilio.com/docs/chat/rest/user-resource) within the [Service](www.twilio.com/docs/chat/rest/service-resource).
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ BindingInstance
constructor
Initialize the BindingInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The absolute URLs of the Binding’s [User](www.twilio.com/docs/chat/rest/user-resource).
-
#message_types ⇒ Array<String>
The [Programmable Chat message types](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Binding resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the Binding resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Binding resource.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ BindingInstance
Initialize the BindingInstance
234 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/chat/v2/service/binding.rb', line 234 def initialize(version, payload , service_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'], 'credential_sid' => payload['credential_sid'], 'binding_type' => payload['binding_type'], 'message_types' => payload['message_types'], 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_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 Binding resource.
277 278 279 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 277 def account_sid @properties['account_sid'] end |
#binding_type ⇒ BindingType
319 320 321 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 319 def binding_type @properties['binding_type'] 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/chat/v2/service/binding.rb', line 262 def context unless @instance_context @instance_context = BindingContext.new(@version , @params['service_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.
313 314 315 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 313 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.
289 290 291 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 289 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.
295 296 297 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 295 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the BindingInstance
344 345 346 347 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 344 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`.
301 302 303 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 301 def endpoint @properties['endpoint'] end |
#fetch ⇒ BindingInstance
Fetch the BindingInstance
352 353 354 355 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 352 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.
307 308 309 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 307 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
366 367 368 369 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 366 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V2.BindingInstance #{values}>" end |
#links ⇒ Hash
Returns The absolute URLs of the Binding’s [User](www.twilio.com/docs/chat/rest/user-resource).
337 338 339 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 337 def links @properties['links'] 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.
325 326 327 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 325 def @properties['message_types'] end |
#service_sid ⇒ String
Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Binding resource is associated with.
283 284 285 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 283 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Binding resource.
271 272 273 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 271 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
359 360 361 362 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 359 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V2.BindingInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Binding resource.
331 332 333 |
# File 'lib/twilio-ruby/rest/chat/v2/service/binding.rb', line 331 def url @properties['url'] end |