Method: XCAPClient::Client#delete

Defined in:
lib/xcapclient/client.rb

#delete(auid, document = nil, check_etag = true) ⇒ Object

Delete a document in the server.

Example:

@xcapclient.delete("pres-rules")

If success:

  • The method returns true.

  • Local plain document and ETag are deleted.



258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/xcapclient/client.rb', line 258

def delete(auid, document=nil, check_etag=true)

  application, document = get_app_doc(auid, document)
  response = send_request(:delete, application, document, nil, nil, nil, nil, check_etag)

  # Reset the local document.
  document.plain = nil
  document.etag = nil

  return true

end