FileLinkRequest.md

DocspaceApiSdk::FileLinkRequest

Properties

Name	Type	Description	Notes
link_id	String	The link to rewrite, as reported by GET api/2.0/files/file/{id}/links. An identifier that is not yet in use, the empty one included, creates a link instead.	[optional]
access	FileShare	The rights the link grants to whoever follows it. The value that denies everything revokes the link.	[optional]
expiration_date	ApiDateTime	The moment the link stops working, read in the time zone of the portal. A date more than a few years ahead is rejected as an invalid request; left out, the link does not expire on its own.	[optional]
title	String	The name the link carries in the sharing list of the file, for the people who manage it; it is not shown to whoever follows the link.	[optional]
internal	Boolean	Who may follow the link: true admits only accounts that are signed in to the portal, false admits anybody who has the address.	[optional]
primary	Boolean	Whether this link becomes the primary link of the file - the one the Copy link action of a client hands out. A file has one primary link at a time.	[optional]
deny_download	Boolean	What a visitor may do with the content: true leaves them with viewing in the browser, false lets them download and print it as their rights allow.	[optional]
password	String	The secret a visitor has to type before the file opens; left out, the link opens without one.	[optional]

Example

require 'docspace-api-sdk'

instance = DocspaceApiSdk::FileLinkRequest.new(
  link_id: 00000000-0000-0000-0000-000000000000,
  access: null,
  expiration_date: null,
  title: My Document,
  internal: false,
  primary: true,
  deny_download: false,
  password: p@ssw0rd
)