Skip to content

Function: createCardAttachment()

ts
function createCardAttachment(client, parameters): Promise<{
  bytes?: string | null;
  date?: Date;
  edgeColor?:   | "green"
     | "yellow"
     | "orange"
     | "red"
     | "purple"
     | "blue"
     | "sky"
     | "lime"
     | "pink"
     | "black"
     | null;
  fileName?: string | null;
  id: string;
  idMember?: string;
  isMalicious?: boolean;
  isUpload?: boolean;
  limits?: {
     attachments?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     boards?: {
        totalAccessRequestsPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalMembersPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerMember?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     cards?: {
        openPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        openPerList?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerList?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     checkItems?: {
        perChecklist?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     checklists?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     customFieldOptions?: {
        perField?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     customFields?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     labels?: {
        perBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     lists?: {
        openPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerBoard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     orgs?: {
        freeBoardsPerOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalMembersPerOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        totalPerMember?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        usersPerFreeOrg?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     reactions?: {
        perAction?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
        uniquePerAction?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
     stickers?: {
        perCard?: {
           count?: number;
           disableAt: number;
           status: string;
           warnAt: number;
        };
     };
  };
  mimeType?: string;
  name?: string;
  pos?: number;
  previews?: string[];
  sourceView?: unknown;
  url?: string;
}>;

Defined in: api/cards.ts:221

Create an Attachment to a Card. See https://glitch.com/~trello-attachments-api for code examples. You may need to remix the project in order to view it.

Parameters

ParameterTypeDescription
clientClient-
parameters{ file?: string; id: unknown; mimeType?: string; name?: string; setCover?: boolean; url?: string; }-
parameters.file?stringThe file to attach, as multipart/form-data
parameters.idunknownThe ID of the Card
parameters.mimeType?stringThe mimeType of the attachment. Max length 256
parameters.name?stringThe name of the attachment. Max length 256.
parameters.setCover?booleanDetermines whether to use the new attachment as a cover for the Card.
parameters.url?stringA URL to attach. Must start with http:// or https://

Returns

Promise<{ bytes?: string | null; date?: Date; edgeColor?: | "green" | "yellow" | "orange" | "red" | "purple" | "blue" | "sky" | "lime" | "pink" | "black" | null; fileName?: string | null; id: string; idMember?: string; isMalicious?: boolean; isUpload?: boolean; limits?: { attachments?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; boards?: { totalAccessRequestsPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; cards?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; openPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checkItems?: { perChecklist?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checklists?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFieldOptions?: { perField?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFields?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; labels?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; lists?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; orgs?: { freeBoardsPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; usersPerFreeOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; reactions?: { perAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; uniquePerAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; stickers?: { perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; }; mimeType?: string; name?: string; pos?: number; previews?: string[]; sourceView?: unknown; url?: string; }>