Module: NextcloudClient

Defined in:
lib/nextcloud-client.rb,
lib/nextcloud-client/api.rb,
lib/nextcloud-client/ocs/app.rb,
lib/nextcloud-client/ocs_api.rb,
lib/nextcloud-client/ocs/user.rb,
lib/nextcloud-client/ocs/group.rb,
lib/nextcloud-client/webdav_api.rb,
lib/nextcloud-client/models/user.rb,
lib/nextcloud-client/models/directory.rb,
lib/nextcloud-client/ocs/group_folder.rb,
lib/nextcloud-client/webdav/directory.rb,
lib/nextcloud-client/helpers/properties.rb,
lib/nextcloud-client/ocs/file_sharing_api.rb,
lib/nextcloud-client/errors/nextcloud-client.rb,
lib/nextcloud-client/helpers/nextcloud-client.rb,
lib/nextcloud-client/version/nextcloud-client.rb

Overview

Namespace for Nextcloud OCS API communication

Defined Under Namespace

Modules: Errors, Helpers, Models, Ocs, Version, Webdav Classes: Api, OcsApi, WebdavApi

Class Method Summary collapse

Class Method Details

.new(args) ⇒ Object

Allow base initializing

Returns:

  • (Object)

    Api



31
32
33
# File 'lib/nextcloud-client.rb', line 31

def new(args)
  Api.new(args)
end

.ocs(args) ⇒ Object

Access to OCS API from base instance

Parameters:

  • args (Hash)

    authentication credentials.

Options Hash (args):

  • :url (String)

    Nextcloud instance URL

  • :username (String)

    Nextcloud instance administrator username

  • :password (String)

    Nextcloud instance administrator password



41
42
43
# File 'lib/nextcloud-client.rb', line 41

def ocs(args)
  OcsApi.new(args)
end

.webdav(args) ⇒ Object

Access to WebDAV API from base instance

Parameters:

  • args (Hash)

    authentication credentials.

Options Hash (args):

  • :url (String)

    Nextcloud instance URL

  • :username (String)

    Nextcloud instance administrator username

  • :password (String)

    Nextcloud instance administrator password



51
52
53
# File 'lib/nextcloud-client.rb', line 51

def webdav(args)
  WebdavApi.new(args)
end