Magpie.FileProperties (Magpie v0.1.0)

Copy Markdown View Source

Endpoints of the Dropbox file_properties namespace: custom property groups attached to files, based on user- or team-owned templates.

The *_for_team template functions require a Dropbox Business (team) token.

Summary

Functions

Add property groups (instances of a template) to a file.

Overwrite existing property groups on a file.

Remove all property groups of the given templates from a file.

Search across property templates for particular property field values. opts accepts "template_filter".

Fetches the next page of results from properties_search/3.

Add, update or remove property fields on a file.

Add a new template owned by the team (team token).

Add a new template owned by the current user.

Get the definition of a team-owned template (team token).

Get the definition of a user-owned template.

List the identifiers of the team-owned templates (team token).

List the identifiers of the user-owned templates.

Permanently remove a team-owned template (team token).

Permanently remove a user-owned template.

Update a team-owned template (team token). opts accepts "name", "description" and "add_fields".

Update a user-owned template. opts accepts "name", "description" and "add_fields".

Functions

properties_add(client, path, property_groups)

Add property groups (instances of a template) to a file.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-add

properties_overwrite(client, path, property_groups)

Overwrite existing property groups on a file.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-overwrite

properties_remove(client, path, property_template_ids)

Remove all property groups of the given templates from a file.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-remove

properties_search(client, queries, opts \\ %{})

Search across property templates for particular property field values. opts accepts "template_filter".

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search

properties_search_continue(client, cursor)

Fetches the next page of results from properties_search/3.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-search-continue

properties_update(client, path, update_property_groups)

Add, update or remove property fields on a file.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-properties-update

templates_add_for_team(client, name, description, fields)

Add a new template owned by the team (team token).

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_team

templates_add_for_user(client, name, description, fields)

Add a new template owned by the current user.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-add_for_user

templates_get_for_team(client, template_id)

Get the definition of a team-owned template (team token).

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_team

templates_get_for_user(client, template_id)

Get the definition of a user-owned template.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-get_for_user

templates_list_for_team(client)

List the identifiers of the team-owned templates (team token).

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_team

templates_list_for_user(client)

List the identifiers of the user-owned templates.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-list_for_user

templates_remove_for_team(client, template_id)

Permanently remove a team-owned template (team token).

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_team

templates_remove_for_user(client, template_id)

Permanently remove a user-owned template.

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-remove_for_user

templates_update_for_team(client, template_id, opts \\ %{})

Update a team-owned template (team token). opts accepts "name", "description" and "add_fields".

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_team

templates_update_for_user(client, template_id, opts \\ %{})

Update a user-owned template. opts accepts "name", "description" and "add_fields".

More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_properties-templates-update_for_user