Sha256: 3b5e163e8b6a72fb69564e78e72a80f03b8169e6fc296f13f2b6442492a3f6a4
Contents?: true
Size: 1.9 KB
Versions: 1
Compression:
Stored size: 1.9 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 ``` ### Parameters * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). --- ## 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`. --- ## Create Export Project ``` Files::Project.create_export ``` --- ## 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.find(id) 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.find(id) project.delete ``` ### Parameters * `id` (int64): Required - Project ID.
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
files.com-1.1.179 | docs/project.md |