Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteInstance
- Defined in:
- lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Invite resource.
-
#channel_sid ⇒ String
The SID of the [Channel](www.twilio.com/docs/chat/channels) the Invite resource belongs to.
-
#context ⇒ InviteContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#created_by ⇒ String
The ‘identity` of the User that created the invite.
-
#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 InviteInstance.
-
#fetch ⇒ InviteInstance
Fetch the InviteInstance.
-
#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, channel_sid: nil, sid: nil) ⇒ InviteInstance
constructor
Initialize the InviteInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#role_sid ⇒ String
The SID of the [Role](www.twilio.com/docs/chat/rest/role-resource) assigned to the resource.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the Invite resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Invite resource.
Constructor Details
#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ InviteInstance
Initialize the InviteInstance
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 274 def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'channel_sid' => payload['channel_sid'], 'service_sid' => payload['service_sid'], 'identity' => payload['identity'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'role_sid' => payload['role_sid'], 'created_by' => payload['created_by'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'channel_sid' => channel_sid || @properties['channel_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 Invite resource.
315 316 317 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 315 def account_sid @properties['account_sid'] end |
#channel_sid ⇒ String
Returns The SID of the [Channel](www.twilio.com/docs/chat/channels) the Invite resource belongs to.
321 322 323 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 321 def channel_sid @properties['channel_sid'] end |
#context ⇒ InviteContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
300 301 302 303 304 305 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 300 def context unless @instance_context @instance_context = InviteContext.new(@version , @params['service_sid'], @params['channel_sid'], @params['sid']) end @instance_context end |
#created_by ⇒ String
Returns The ‘identity` of the User that created the invite.
357 358 359 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 357 def created_by @properties['created_by'] 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.
339 340 341 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 339 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.
345 346 347 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 345 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the InviteInstance
370 371 372 373 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 370 def delete context.delete end |
#fetch ⇒ InviteInstance
Fetch the InviteInstance
378 379 380 381 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 378 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.
333 334 335 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 333 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
392 393 394 395 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 392 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V2.InviteInstance #{values}>" end |
#role_sid ⇒ String
Returns The SID of the [Role](www.twilio.com/docs/chat/rest/role-resource) assigned to the resource.
351 352 353 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 351 def role_sid @properties['role_sid'] end |
#service_sid ⇒ String
Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with.
327 328 329 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 327 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Invite resource.
309 310 311 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 309 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
385 386 387 388 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 385 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V2.InviteInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Invite resource.
363 364 365 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 363 def url @properties['url'] end |