Class: Twilio::REST::Chat::V1::ServiceContext::ChannelContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Chat::V1::ServiceContext::ChannelContext
- Defined in:
- lib/twilio-ruby/rest/chat/v1/service/channel.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/member.rb,
lib/twilio-ruby/rest/chat/v1/service/channel/message.rb
Defined Under Namespace
Classes: InviteContext, InviteInstance, InviteList, InvitePage, MemberContext, MemberInstance, MemberList, MemberPage, MessageContext, MessageInstance, MessageList, MessagePage
Instance Method Summary collapse
-
#delete ⇒ Boolean
Delete the ChannelInstance.
-
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance.
-
#initialize(version, service_sid, sid) ⇒ ChannelContext
constructor
Initialize the ChannelContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#invites(sid = :unset) ⇒ InviteList, InviteContext
Access the invites.
-
#members(sid = :unset) ⇒ MemberList, MemberContext
Access the members.
-
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance.
Constructor Details
#initialize(version, service_sid, sid) ⇒ ChannelContext
Initialize the ChannelContext
189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 189 def initialize(version, service_sid, sid) super(version) # Path Solution @solution = {service_sid: service_sid, sid: sid, } @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}" # Dependents @members = nil @messages = nil @invites = nil end |
Instance Method Details
#delete ⇒ Boolean
Delete the ChannelInstance
214 215 216 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 214 def delete @version.delete('DELETE', @uri) end |
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance
205 206 207 208 209 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 205 def fetch payload = @version.fetch('GET', @uri) ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
316 317 318 319 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 316 def inspect context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Chat.V1.ChannelContext #{context}>" end |
#invites(sid = :unset) ⇒ InviteList, InviteContext
Access the invites
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 289 def invites(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid, ) end unless @invites @invites = InviteList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @invites end |
#members(sid = :unset) ⇒ MemberList, MemberContext
Access the members
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 245 def members(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid, ) end unless @members @members = MemberList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @members end |
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 267 def (sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid, ) end unless @messages @messages = MessageList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @messages end |
#to_s ⇒ Object
Provide a user friendly representation
309 310 311 312 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 309 def to_s context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Chat.V1.ChannelContext #{context}>" end |
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance
229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 229 def update(friendly_name: :unset, unique_name: :unset, attributes: :unset) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'UniqueName' => unique_name, 'Attributes' => attributes, }) payload = @version.update('POST', @uri, data: data) ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) end |