Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
quickstart
command
[START quickstart]
|
[START quickstart] |
|
recipes/connect
command
Recipe "connect": the server version and capabilities before logging in, then log in, read the session, keep it alive and log out.
|
Recipe "connect": the server version and capabilities before logging in, then log in, read the session, keep it alive and log out. |
|
recipes/create_document
command
Recipe "create-document": upload a file and create a single-file document from it.
|
Recipe "create-document": upload a file and create a single-file document from it. |
|
recipes/download_file
command
Recipe "download-file": download the files of a document's latest version to a folder.
|
Recipe "download-file": download the files of a document's latest version to a folder. |
|
recipes/errors
command
Recipe "errors": provoke "not found" and "access denied" and show the decoded M-Files errors.
|
Recipe "errors": provoke "not found" and "access denied" and show the decoded M-Files errors. |
|
recipes/internal/recipe
Package recipe holds what the recipes share: arguments, connecting, printing values and the test documents some recipes create.
|
Package recipe holds what the recipes share: arguments, connecting, printing values and the test documents some recipes create. |
|
recipes/login_service
command
Recipe "login_service": sign in through M-Files Login Service, or the vault's other OAuth plugin, in the browser, then log in to the vault with the token.
|
Recipe "login_service": sign in through M-Files Login Service, or the vault's other OAuth plugin, in the browser, then log in to the vault with the token. |
|
recipes/paging
command
Recipe "paging": read every document, a page at a time, in object ID order.
|
Recipe "paging": read every document, a page at a time, in object ID order. |
|
recipes/read_object
command
Recipe "read-object": an object's latest version and its properties as typed values.
|
Recipe "read-object": an object's latest version and its properties as typed values. |
|
recipes/search
command
Recipe "search": documents of one class modified in the last N days, newest first.
|
Recipe "search": documents of one class modified in the last N days, newest first. |
|
recipes/update_properties
command
Recipe "update-properties": change properties of a document two ways: in one call with an explicit version, and with check out, set, check in.
|
Recipe "update-properties": change properties of a document two ways: in one call with an explicit version, and with check out, set, check in. |
|
recipes/vault_structure
command
Recipe "vault-structure": object types, the classes of documents with their properties, and IDs resolved by alias.
|
Recipe "vault-structure": object types, the classes of documents with their properties, and IDs resolved by alias. |
|
recipes/workflow_state
command
Recipe "workflow-state": read a document's workflow states and transitions, then move it to another state.
|
Recipe "workflow-state": read a document's workflow states and transitions, then move it to another state. |
|
Package mfilesclient connects to the M-Files gRPC API: it creates the channel, adds the call metadata M-Files expects, logs in and out, and turns failed calls into *Error values that carry the M-Files error code.
|
Package mfilesclient connects to the M-Files gRPC API: it creates the channel, adds the call metadata M-Files expects, logs in and out, and turns failed calls into *Error values that carry the M-Files error code. |
Click to show internal directories.
Click to hide internal directories.