appcatalog¶

The ability to use Teams App Catalog

More information can be found in the official Graph documentation:

App Catalogs Resource Type

AppCatalog, IAppCatalog¶

Get Teams Apps in App Catalog¶

Using teamsApps() you get the Teams AppCatalog

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

const apps = await graph.appCatalog.teamsApps();

Get Teams Apps by Id¶

Using getById() you get the Teams App by Id

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

const apps = await graph.appCatalog.teamsApps.getById('{teams app id}')();

Add a Teams App¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);
const appPackage = {...} as Blob;

//second parameter is "Requires Approval"
const app = await graph.appCatalog.teamsApps.getById('{teams app id}').add(appPackage, false);

Update a Teams App¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);
const appPackage = {...} as Blob;

//second parameter is "Requires Approval"
const app = await graph.appCatalog.teamsApps.getById('{teams app id}').update(appPackage, false);

Delete a Teams App¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

//delete a Teams App
await graph.appCatalog.teamsApps.getById(app).delete();

// delete an un-approved Teams App requires the app definition id.
// sample is just selecting the first app definition.
const appDefinition = (await graph.appCatalog.teamsApps.getById("{teams app id}")()).appDefinitions[0];
await graph.appCatalog.teamsApps.getById(app).delete(appDefinition);

Get Teams App Definitions¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

//get teams app definitions
await graph.appCatalog.teamsApps.getById(`{teams app id}`).appDefinitions();

Get Teams App Definitions by Id¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

//get teams app definitions
await graph.appCatalog.teamsApps.getById(`{teams app id}`).appDefinitions.getById(`{Teams App Definition Id}`)

Get Bot associated with Teams App Definition¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/teams";
import "@pnp/graph/appCatalog";

const graph = graphfi(...);

await graph.appCatalog.teamsApps.getById(`{teams app id}`).appDefinitions.getById(`{Teams App Definition Id}`).bot();