Sha256: 9f4e4d4acebc47899527d213255c09c8c2066bd09a13cf0d4f2f0846e6f9bd90

Contents?: true

Size: 1.67 KB

Versions: 45

Compression:

Stored size: 1.67 KB

Contents

# Project

## Example Project Object

```
{
  "id": 1,
  "global_access": "none"
}
```

* `id` (int64): Project ID
* `global_access` (string): Global access settings


---

## List Projects

```
Files::Project.list(
  page: 1, 
  per_page: 1
)
```

### Parameters

* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.


---

## Show Project

```
Files::Project.find(id)
```

### Parameters

* `id` (int64): Required - Project ID.


---

## Create Project

```
Files::Project.create(
  global_access: "global_access"
)
```

### Parameters

* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.


---

## Update Project

```
Files::Project.update(id, 
  global_access: "global_access"
)
```

### Parameters

* `id` (int64): Required - Project ID.
* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.


---

## Delete Project

```
Files::Project.delete(id)
```

### Parameters

* `id` (int64): Required - Project ID.


---

## Update Project

```
project = Files::Project.list_for(path).first

project.update(
  global_access: "global_access"
)
```

### Parameters

* `id` (int64): Required - Project ID.
* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.


---

## Delete Project

```
project = Files::Project.list_for(path).first

project.delete
```

### Parameters

* `id` (int64): Required - Project ID.

Version data entries

45 entries across 45 versions & 1 rubygems

Version Path
files.com-1.0.104 docs/project.md
files.com-1.0.103 docs/project.md
files.com-1.0.102 docs/project.md
files.com-1.0.101 docs/project.md
files.com-1.0.100 docs/project.md
files.com-1.0.99 docs/project.md
files.com-1.0.98 docs/project.md
files.com-1.0.97 docs/project.md
files.com-1.0.96 docs/project.md
files.com-1.0.95 docs/project.md
files.com-1.0.94 docs/project.md
files.com-1.0.93 docs/project.md
files.com-1.0.92 docs/project.md
files.com-1.0.91 docs/project.md
files.com-1.0.90 docs/project.md
files.com-1.0.89 docs/project.md
files.com-1.0.88 docs/project.md
files.com-1.0.87 docs/project.md
files.com-1.0.86 docs/project.md
files.com-1.0.85 docs/project.md