Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserContext::UserChannelContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, user_sid, channel_sid) ⇒ UserChannelContext

Initialize the UserChannelContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • user_sid (String)
  • channel_sid (String) 


137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 137

def initialize(version, service_sid, user_sid, channel_sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, user_sid: user_sid, channel_sid: channel_sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels/#{@solution[:channel_sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the UserChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



149
150
151
152
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 149

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ UserChannelInstance

Fetch the UserChannelInstance

Returns:



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 157

def fetch

    payload = @version.fetch('GET', @uri)
    UserChannelInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:user_sid],
        channel_sid: @solution[:channel_sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



207
208
209
210
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 207

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



200
201
202
203
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 200

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
end

#update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset) ⇒ UserChannelInstance

Update the UserChannelInstance

Parameters:

  • notification_level (NotificationLevel) (defaults to: :unset)
  • last_consumed_message_index (String) (defaults to: :unset)
  • last_consumption_timestamp (Time) (defaults to: :unset)

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb', line 175

def update(
    notification_level: :unset, 
    last_consumed_message_index: :unset, 
    last_consumption_timestamp: :unset
)

    data = Twilio::Values.of({
        'NotificationLevel' => notification_level,
        'LastConsumedMessageIndex' => last_consumed_message_index,
        'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
    })

    payload = @version.update('POST', @uri, data: data)
    UserChannelInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:user_sid],
        channel_sid: @solution[:channel_sid],
    )
end