Class: Twilio::REST::Chat::V1::ServiceContext::ChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil)

    The SID of the Service the resource is associated with.

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the Channel resource to fetch.


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 333

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'],
      'friendly_name' => payload['friendly_name'],
      'unique_name' => payload['unique_name'],
      'attributes' => payload['attributes'],
      'type' => payload['type'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'created_by' => payload['created_by'],
      'members_count' => payload['members_count'].to_i,
      'messages_count' => payload['messages_count'].to_i,
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


378
379
380
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 378

def 
  @properties['account_sid']
end

#attributesString

Returns The JSON string that stores application-specific data.

Returns:

  • (String)

    The JSON string that stores application-specific data


402
403
404
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 402

def attributes
  @properties['attributes']
end

#contextChannelContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


363
364
365
366
367
368
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 363

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

#created_byString

Returns The identity of the User that created the channel.

Returns:

  • (String)

    The identity of the User that created the channel


426
427
428
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 426

def created_by
  @properties['created_by']
end

#date_createdTime

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was created


414
415
416
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 414

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was last updated


420
421
422
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 420

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the ChannelInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


464
465
466
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 464

def delete
  context.delete
end

#fetchChannelInstance

Fetch the ChannelInstance

Returns:


457
458
459
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 457

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


390
391
392
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 390

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


513
514
515
516
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 513

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

#invitesinvites

Access the invites

Returns:


500
501
502
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 500

def invites
  context.invites
end

Returns Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel.

Returns:

  • (String)

    Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel


450
451
452
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 450

def links
  @properties['links']
end

#membersmembers

Access the members

Returns:


486
487
488
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 486

def members
  context.members
end

#members_countString

Returns The number of Members in the Channel.

Returns:

  • (String)

    The number of Members in the Channel


432
433
434
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 432

def members_count
  @properties['members_count']
end

#messagesmessages

Access the messages

Returns:


493
494
495
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 493

def messages
  context.messages
end

#messages_countString

Returns The number of Messages in the Channel.

Returns:

  • (String)

    The number of Messages in the Channel


438
439
440
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 438

def messages_count
  @properties['messages_count']
end

#service_sidString

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

Returns:

  • (String)

    The SID of the Service that the resource is associated with


384
385
386
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 384

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


372
373
374
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 372

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


506
507
508
509
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 506

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

#typechannel.ChannelType

Returns The visibility of the channel. Can be: `public` or `private`.

Returns:

  • (channel.ChannelType)

    The visibility of the channel. Can be: `public` or `private`


408
409
410
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 408

def type
  @properties['type']
end

#unique_nameString

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


396
397
398
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 396

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance

Update the ChannelInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • unique_name (String) (defaults to: :unset)

    An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.

  • attributes (String) (defaults to: :unset)

    A valid JSON string that contains application-specific data.

Returns:


479
480
481
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 479

def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
  context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, )
end

#urlString

Returns The absolute URL of the Channel resource.

Returns:

  • (String)

    The absolute URL of the Channel resource


444
445
446
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 444

def url
  @properties['url']
end