Attachment Field ​

The Attachment field represents a field that can store attachments, such as files or images. It provides methods to manage and manipulate attachment data.

To use the Attachment field, you need to define its type as IAttachmentField and retrieve the field using the getField method of the table object. Here's an example:

const attachmentField = await table.getField<IAttachmentField>(fieldId);

const attachmentField = await table.getField<IAttachmentField>(fieldId);

The IAttachmentField type defines the following properties for an attachment:

type IOpenAttachment = {
  name: string;
  size: number;
  type: string; // mime
  token: string;
  timeStamp: number;
};

type IOpenAttachment = {
  name: string;
  size: number;
  type: string; // mime
  token: string;
  timeStamp: number;
};

getAttachmentUrls ​

getAttachmentUrls: (recordOrId: IRecordType | string) => Promise<string[]>;

getAttachmentUrls: (recordOrId: IRecordType | string) => Promise<string[]>;

This method retrieves the URLs of the attachments associated with a record. It returns a Promise that resolves to an array of attachment URLs.

setOnlyMobile ​

setOnlyMobile: (onlyMobile: boolean) => Promise<IFieldRes>;

setOnlyMobile: (onlyMobile: boolean) => Promise<IFieldRes>;

This method sets whether the attachment field can only be filled on mobile devices. It accepts a boolean value indicating whether only mobile devices are allowed. It returns a Promise that resolves to an IFieldRes object.

getOnlyMobile ​

getOnlyMobile: () => Promise<boolean>;

getOnlyMobile: () => Promise<boolean>;

This method retrieves whether the attachment field can only be filled on mobile devices. It returns a Promise that resolves to a boolean value indicating whether only mobile devices are allowed.

createCell ​

createCell: (val: File | File[] | FileList | IOpenAttachment | IOpenAttachment[]) => Promise<ICell>;

createCell: (val: File | File[] | FileList | IOpenAttachment | IOpenAttachment[]) => Promise<ICell>;

This method creates a new cell for the attachment field. It accepts a value representing the attachment, such as a File object or an array of File objects. It returns a Promise that resolves to an ICell object representing the new cell.

getCell ​

getCell: (recordOrId: IRecordType | string) => Promise<ICell>

getCell: (recordOrId: IRecordType | string) => Promise<ICell>

This method retrieves the cell for the attachment field associated with a record. It accepts a record object or record ID as a parameter. It returns a Promise that resolves to the ICell object representing the cell.

setValue ​

setValue: (recordOrId: IRecordType | string, val: AttachmentTransformVal ) => Promise<boolean>;

setValue: (recordOrId: IRecordType | string, val: AttachmentTransformVal ) => Promise<boolean>;

This method sets the value of the attachment field for a record. It accepts a record object or record ID as the first parameter and the attachment value as the second parameter. The attachment value can be a File object, an array of File objects, or an array of IOpenAttachment objects. It returns a Promise that resolves to a boolean indicating whether the value was successfully set.

getValue ​

getValue: (recordOrId: IRecordType | string) => Promise<IOpenAttachment[]>;

getValue: (recordOrId: IRecordType | string) => Promise<IOpenAttachment[]>;

This method retrieves the value of the attachment field for a record. It accepts a record object or record ID as a parameter. It returns a Promise that resolves to an array of IOpenAttachment objects representing the attachments.