25.11.2 • Published 10 months ago

@inweb/client v25.11.2

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
-
Last release
10 months ago

Client.js

Client.js is a JavaScript library implementing the REST API client for Open Cloud Server.

Core capabilities:

  • Register on the server as a new user.
  • Create new and manage existing user accounts.
  • Upload and download files from the server.
  • Manage existing files, upload new version of files.
  • Convert files from one format to another.
  • Run validation, clash detection, and custom jobs on the server.
  • Create and manage assemblies.
  • Create projects, manage project models and members.
  • Change server settings.

This library is a part of CDE SDK by Open Design Alliance.

Installation

CDN or static hosting

For CDN, you can use unpkg or jsDelivr (replace 25.3 with a version you need):

<script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>

The global namespace for Client.js is ODA.Api.

<script>
  const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
</script>

Install via npm

Open a terminal in your project folder and run:

npm install @inweb/client

The Client.js package will be downloaded and installed. Then you're ready to import it in your code:

import { Client } from "@inweb/client";
const client = new Client({ serverUrl: "https://cloud.opendesign.com/api" });

Example

Login to the Open Cloud Server and get the file list from the server:

<html>
  <body>
    <script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>
    <script>
      const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
      client
        .signInWithEmail("email", "password")
        .then(() => client.getFiles())
        .then((files) => files.result.map((file) => file.name))
        .then((names) => console.log(names));
    </script>
  </body>
</html>

To learn more, see First application guide.

Copyright and license

Code and documentation copyright 2002-2024 the Open Design Alliance. Code is distributed under a proprietary license, see LICENSE for more information.

25.10.1

10 months ago

25.11.1

10 months ago

25.11.2

10 months ago

25.11.0

11 months ago

25.10.0

11 months ago

25.9.8

1 year ago

25.8.23

12 months ago

25.7.13

12 months ago

25.8.20

1 year ago

25.8.15

1 year ago

25.8.14

1 year ago

25.8.16

1 year ago

25.8.11

1 year ago

25.8.10

1 year ago

25.8.13

1 year ago

25.8.12

1 year ago

25.8.19

1 year ago

25.5.0

1 year ago

25.7.1

1 year ago

25.5.3

1 year ago

25.7.0

1 year ago

25.9.5

1 year ago

25.7.7

1 year ago

25.9.4

1 year ago

25.7.6

1 year ago

25.9.7

1 year ago

25.7.9

1 year ago

25.9.6

1 year ago

25.7.8

1 year ago

25.9.1

1 year ago

25.7.3

1 year ago

25.9.0

1 year ago

25.7.2

1 year ago

25.9.3

1 year ago

25.7.5

1 year ago

25.9.2

1 year ago

25.7.4

1 year ago

25.6.0

1 year ago

25.8.0

1 year ago

25.6.2

1 year ago

25.6.1

1 year ago

25.8.22

1 year ago

25.7.10

1 year ago

25.8.21

1 year ago

25.8.9

1 year ago

25.7.12

1 year ago

25.7.11

1 year ago

25.8.6

1 year ago

25.6.8

1 year ago

25.8.5

1 year ago

25.6.7

1 year ago

25.8.8

1 year ago

25.8.7

1 year ago

25.8.2

1 year ago

25.6.4

1 year ago

25.8.1

1 year ago

25.6.3

1 year ago

25.8.4

1 year ago

25.6.6

1 year ago

25.8.3

1 year ago

25.6.5

1 year ago

25.4.11

1 year ago

25.5.4

1 year ago

25.4.10

1 year ago

25.4.7

1 year ago

25.4.6

1 year ago

25.4.4

1 year ago

25.4.2

1 year ago

25.4.3

1 year ago

25.4.1

1 year ago

25.4.0

1 year ago

25.3.26

1 year ago

25.3.25

1 year ago

25.3.23

1 year ago

25.3.24

1 year ago

25.3.22

1 year ago

25.3.21

1 year ago

25.3.20

1 year ago

25.3.19

1 year ago

25.2.12

1 year ago

25.3.18

1 year ago

25.3.17

1 year ago

25.3.15

1 year ago

25.3.13

1 year ago

25.3.12

1 year ago

25.3.11

2 years ago

25.3.10

2 years ago

25.3.9

2 years ago

25.3.8

2 years ago

25.3.7

2 years ago

25.3.6

2 years ago

25.3.5

2 years ago

25.3.3

2 years ago

25.3.2

2 years ago

25.3.4

2 years ago

25.3.0

2 years ago

25.2.10

2 years ago

25.2.8

2 years ago

25.2.5

2 years ago

25.2.2

2 years ago