Skip to main content

Interface: FilesRemoteAddArguments

Defined in: packages/web-api/src/types/request/files.ts:196

Extends​

  • SharedFile.FileType.ExternalIDArgument.TokenOverridable

Properties​

external_id​

external_id: string;

Defined in: packages/web-api/src/types/request/files.ts:17

Description​

Creator defined GUID for the file.

Inherited from​

ExternalIDArgument.external_id

external_url​

external_url: string;

Defined in: packages/web-api/src/types/request/files.ts:185

Description​

URL of the remote file.

Inherited from​

SharedFile.external_url

filetype?​

optional filetype: string;

Defined in: packages/web-api/src/types/request/files.ts:31

Description​

A file type identifier.

See​

File types for a complete list of supported file types.

Inherited from​

FileType.filetype

indexable_file_contents?​

optional indexable_file_contents: Buffer | Stream;

Defined in: packages/web-api/src/types/request/files.ts:192

Description​

A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.

Inherited from​

SharedFile.indexable_file_contents

preview_image?​

optional preview_image: Buffer | Stream;

Defined in: packages/web-api/src/types/request/files.ts:187

Description​

Preview of the document.

Inherited from​

SharedFile.preview_image

title​

title: string;

Defined in: packages/web-api/src/types/request/files.ts:183

Description​

Title of the file being shared.

Inherited from​

SharedFile.title

token?​

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token