saved-views-client

@itwin/saved-views-client

About

This package hosts client-side code and TypeScript types for interacting with iTwin Platform Saved Views API.

Usage

import { ITwinSavedViewsClient } from "@itwin/saved-views-client";

const client = new ITwinSavedViewsClient({
  // auth_token should have access to savedviews:read and savedviews:modify OIDC scopes
  getAccessToken: async () => "<auth_token>",
});

const { savedView } = await client.getSavedViewMinimal({ savedViewId: "<saved_view_id>" });
console.log(savedView); /*
{
  id: "<saved_view_id>",
  displayName: "Saved View",
  creationTime: "2024-01-01T10:00:00.000Z",
  lastModified: "2024-01-01T10:01:00.000Z",
  groupId: undefined,
  shared: false,
  tags: [...],
  savedViewData: { itwin3dView: {...} },
  extensions: [...],
  _links: {...}
} */

Contributing

We welcome contributions to make this package better. You can submit feature requests or report bugs by creating an issue.

---

Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.