Skip to content

Function: enableBoardPlugin()

ts
function enableBoardPlugin(client, parameters): Promise<{
  author?: string | null;
  capabilities?: string[];
  capabilitiesOptions?: unknown[];
  categories?: string[];
  claimedDomains?: unknown[];
  heroImageUrl?:   | {
     _id?: string;
     @1x?: string;
     @2x?: string;
   }
     | null;
  icon?:   | {
     url?: string;
   }
     | null;
  id: string;
  idBoard?: string | null;
  idOrganizationOwner?: string | null;
  idPlugin?: string | null;
  iframeConnectorUrl?: string | null;
  isCompliantWithPrivacyStandards?: boolean;
  listing?:   | {
     description?: string | null;
     locale?: string | null;
     name?: string | null;
     overview?: string | null;
     updates?: unknown[];
   }
     | null;
  moderatedState?: string | null;
  name?: string | null;
  privacyUrl?: string | null;
  promotional?: boolean;
  public?: boolean;
  supportEmail?: string | null;
  tags?: string[];
  url?: string | null;
  usageBrackets?:   | {
     boards?: number;
   }
     | null;
}>;

Defined in: api/boards.ts:563

Enable a Power-Up on a Board

Parameters

ParameterTypeDescription
clientClient-
parameters{ id: unknown; idPlugin?: unknown; }-
parameters.idunknownThe ID of the Board
parameters.idPlugin?unknownThe ID of the Power-Up to enable

Returns

Promise<{ author?: string | null; capabilities?: string[]; capabilitiesOptions?: unknown[]; categories?: string[]; claimedDomains?: unknown[]; heroImageUrl?: | { _id?: string; @1x?: string; @2x?: string; } | null; icon?: | { url?: string; } | null; id: string; idBoard?: string | null; idOrganizationOwner?: string | null; idPlugin?: string | null; iframeConnectorUrl?: string | null; isCompliantWithPrivacyStandards?: boolean; listing?: | { description?: string | null; locale?: string | null; name?: string | null; overview?: string | null; updates?: unknown[]; } | null; moderatedState?: string | null; name?: string | null; privacyUrl?: string | null; promotional?: boolean; public?: boolean; supportEmail?: string | null; tags?: string[]; url?: string | null; usageBrackets?: | { boards?: number; } | null; }>