Interface: FilesRemoteAddArguments
Extends
SharedFile.FileType.ExternalIDArgument.TokenOverridable
Properties
external_id
external_id: string;
Description
Creator defined GUID for the file.
Inherited from
ExternalIDArgument.external_id
Defined in
packages/web-api/src/types/request/files.ts:17
external_url
external_url: string;
Description
URL of the remote file.
Inherited from
SharedFile.external_url
Defined in
packages/web-api/src/types/request/files.ts:185
filetype?
optional filetype: string;
Description
A file type identifier.
See
File types for a complete list of supported file types.
Inherited from
FileType.filetype
Defined in
packages/web-api/src/types/request/files.ts:31
indexable_file_contents?
optional indexable_file_contents: Buffer | Stream;
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
Defined in
packages/web-api/src/types/request/files.ts:192
preview_image?
optional preview_image: Buffer | Stream;
Description
Preview of the document.
Inherited from
SharedFile.preview_image
Defined in
packages/web-api/src/types/request/files.ts:187
title
title: string;
Description
Title of the file being shared.
Inherited from
SharedFile.title
Defined in
packages/web-api/src/types/request/files.ts:183
token?
optional token: string;
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token