Class: Twilio::REST::Chat::V3::ChannelInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v3/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 unique SID identifier of the Service.

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this Channel.


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 117

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,
      'messaging_service_sid' => payload['messaging_service_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid || @properties['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


165
166
167
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 165

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


189
190
191
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 189

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:


150
151
152
153
154
155
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 150

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


213
214
215
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 213

def created_by
  @properties['created_by']
end

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


201
202
203
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 201

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


207
208
209
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 207

def date_updated
  @properties['date_updated']
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


177
178
179
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 177

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


267
268
269
270
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 267

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

#members_countString

Returns The number of Members in the Channel.

Returns:

  • (String)

    The number of Members in the Channel


219
220
221
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 219

def members_count
  @properties['members_count']
end

#messages_countString

Returns The number of Messages that have been passed in the Channel.

Returns:

  • (String)

    The number of Messages that have been passed in the Channel


225
226
227
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 225

def messages_count
  @properties['messages_count']
end

#messaging_service_sidString

Returns The unique ID of the Messaging Service this channel belongs to.

Returns:

  • (String)

    The unique ID of the Messaging Service this channel belongs to.


231
232
233
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 231

def messaging_service_sid
  @properties['messaging_service_sid']
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


171
172
173
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 171

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


159
160
161
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 159

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


260
261
262
263
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 260

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.V3.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`


195
196
197
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 195

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


183
184
185
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 183

def unique_name
  @properties['unique_name']
end

#update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance

Parameters:

  • type (channel.ChannelType) (defaults to: :unset)

    TThe Type for this Channel to migrate to. Can only be `private`. Migration to 'public' is not allowed.

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

    The unique ID of the Messaging Service this channel belongs to.

  • x_twilio_webhook_enabled (channel.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


250
251
252
253
254
255
256
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 250

def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
  context.update(
      type: type,
      messaging_service_sid: messaging_service_sid,
      x_twilio_webhook_enabled: x_twilio_webhook_enabled,
  )
end

#urlString

Returns The absolute URL of the Channel resource.

Returns:

  • (String)

    The absolute URL of the Channel resource


237
238
239
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 237

def url
  @properties['url']
end