Skip to content

Function: getNotificationCard()

ts
function getNotificationCard(client, parameters): Promise<{
  address?: string | null;
  agent?: {
     conversationId?: string | null;
     name?: string | null;
  };
  attachments?: unknown[];
  badges?: {
     attachments?: number;
     attachmentsByType?: {
        trello?: {
           board?: number;
           card?: number;
        };
     };
     checkItems?: number;
     checkItemsChecked?: number;
     checkItemsEarliestDue?: Date | null;
     comments?: number;
     description?: boolean;
     due?: Date | null;
     dueComplete?: boolean;
     externalSource?: Record<string, any> | null;
     fogbugz?: string;
     lastUpdatedByAi?: boolean;
     location?: boolean;
     maliciousAttachments?: number;
     start?: Date | null;
     subscribed?: boolean;
     viewingMemberVoted?: boolean;
     votes?: number;
  };
  cardRole?: "link" | "board" | "separator" | "mirror" | null;
  checkItemStates?: string[];
  closed?: boolean;
  coordinates?: string | null;
  cover?: {
     brightness?: "light" | "dark";
     color?:   | "green"
        | "yellow"
        | "orange"
        | "red"
        | "purple"
        | "blue"
        | "sky"
        | "lime"
        | "pink"
        | "black"
        | null;
     idAttachment?: string | null;
     idPlugin?: string | null;
     idUploadedBackground?: boolean | null;
     isTemplate?: boolean;
     size?: "normal";
     yPosition?: number;
  };
  creationMethod?: string | null;
  creationMethodError?: unknown;
  creationMethodLoadingStartedAt?: unknown;
  customFieldItems?: unknown[];
  dateClosed?: unknown;
  dateCompleted?: unknown;
  dateLastActivity?: Date;
  dateViewedByCreator?: unknown;
  desc?: string;
  descData?: {
     emoji?: Record<string, any>;
  };
  due?: Date | null;
  dueComplete?: boolean;
  dueReminder?: string | null;
  email?: string | null;
  externalSource?: unknown;
  faviconUrl?: unknown;
  id: string;
  idAttachmentCover?: string | null;
  idBoard?: string;
  idChecklists?: unknown[];
  idLabels?: unknown[];
  idList?: string;
  idMemberCreator?: string | null;
  idMembers?: unknown[];
  idMembersVoted?: unknown[];
  idOrganization?: string | null;
  idShort?: number;
  isTemplate?: boolean;
  labels?: unknown[];
  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;
        };
     };
  };
  locationName?: string | null;
  manifest?: unknown;
  manualCoverAttachment?: boolean;
  members?: unknown[];
  membersVoted?: unknown[];
  mirrorSourceId?: string | null;
  mirrorSourceNodeId?: unknown;
  name?: string;
  nodeId?: string;
  originalDesc?: string | null;
  originalName?: string | null;
  pinned?: boolean;
  pluginData?: unknown[];
  pos?: number;
  recurrenceRule?: unknown;
  shortLink?: string;
  shortUrl?: string;
  singleInstrumentationId?: unknown;
  sourceEmail?: unknown;
  start?: Date | null;
  staticMapUrl?: unknown;
  stickers?: unknown[];
  subscribed?: boolean;
  url?: string;
  urlSource?: unknown;
  urlSourceText?: unknown;
}>;

Defined in: api/notifications.ts:122

Get the card a notification is associated with

Parameters

ParameterTypeDescription
clientClient-
parameters{ fields?: unknown; id: unknown; }-
parameters.fields?unknownall or a comma-separated list of card fields
parameters.idunknownThe ID of the notification

Returns

Promise<{ address?: string | null; agent?: { conversationId?: string | null; name?: string | null; }; attachments?: unknown[]; badges?: { attachments?: number; attachmentsByType?: { trello?: { board?: number; card?: number; }; }; checkItems?: number; checkItemsChecked?: number; checkItemsEarliestDue?: Date | null; comments?: number; description?: boolean; due?: Date | null; dueComplete?: boolean; externalSource?: Record<string, any> | null; fogbugz?: string; lastUpdatedByAi?: boolean; location?: boolean; maliciousAttachments?: number; start?: Date | null; subscribed?: boolean; viewingMemberVoted?: boolean; votes?: number; }; cardRole?: "link" | "board" | "separator" | "mirror" | null; checkItemStates?: string[]; closed?: boolean; coordinates?: string | null; cover?: { brightness?: "light" | "dark"; color?: | "green" | "yellow" | "orange" | "red" | "purple" | "blue" | "sky" | "lime" | "pink" | "black" | null; idAttachment?: string | null; idPlugin?: string | null; idUploadedBackground?: boolean | null; isTemplate?: boolean; size?: "normal"; yPosition?: number; }; creationMethod?: string | null; creationMethodError?: unknown; creationMethodLoadingStartedAt?: unknown; customFieldItems?: unknown[]; dateClosed?: unknown; dateCompleted?: unknown; dateLastActivity?: Date; dateViewedByCreator?: unknown; desc?: string; descData?: { emoji?: Record<string, any>; }; due?: Date | null; dueComplete?: boolean; dueReminder?: string | null; email?: string | null; externalSource?: unknown; faviconUrl?: unknown; id: string; idAttachmentCover?: string | null; idBoard?: string; idChecklists?: unknown[]; idLabels?: unknown[]; idList?: string; idMemberCreator?: string | null; idMembers?: unknown[]; idMembersVoted?: unknown[]; idOrganization?: string | null; idShort?: number; isTemplate?: boolean; labels?: unknown[]; 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; }; }; }; locationName?: string | null; manifest?: unknown; manualCoverAttachment?: boolean; members?: unknown[]; membersVoted?: unknown[]; mirrorSourceId?: string | null; mirrorSourceNodeId?: unknown; name?: string; nodeId?: string; originalDesc?: string | null; originalName?: string | null; pinned?: boolean; pluginData?: unknown[]; pos?: number; recurrenceRule?: unknown; shortLink?: string; shortUrl?: string; singleInstrumentationId?: unknown; sourceEmail?: unknown; start?: Date | null; staticMapUrl?: unknown; stickers?: unknown[]; subscribed?: boolean; url?: string; urlSource?: unknown; urlSourceText?: unknown; }>