Class: Twilio::REST::Chat::V2::ServiceContext::RoleContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/role.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ RoleContext

Initialize the RoleContext

Parameters:



163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 163

def initialize(version, service_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Roles/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 175

def delete

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

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 184

def fetch

    
    payload = @version.fetch('GET', @uri)
    RoleInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



228
229
230
231
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 228

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

#to_s ⇒ Object

Provide a user friendly representation



221
222
223
224
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 221

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

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

  • permission (Array[String]) (defaults to: nil) —

    A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role’s ‘type`.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 200

def update(
    permission: nil
)

    data = Twilio::Values.of({
        'Permission' => Twilio.serialize_list(permission) { |e| e },
    })

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