Library page APIs

The LibraryPage object is the manipulator of the MicroStrategy Library home page. It could be got by embeddingContext.libraryPage.

The embeddingContext object could be created as below:

try {
  const embeddingContext = await microstrategy.embeddingContexts.embedLibraryPage({
    serverUrl: "{YOUR_LIBRARY_SERVER_URL}",
    placeholder: document.getElementById("dossierContainer"),
  });
  // An example to call the LibraryPage APIs
  const myGroups = await embeddingContext.libraryPage.getAllMyGroups();
} catch (err) {
  // Your custom error handling logic here
}

This object is actually a service object that would persist in the embedding context. So if the user goes to a dossier page from the home page, then return to the home page again, this object could still be used.

If the user wants to use the APIs below to manipulate the Library home page when he embeds a dossier page by microstrategy.dossier.create() at first, he could do the following things:

• Click the "Go to Library" icon on the page to navigate to the Library home page;
• Call Dossier.getEmbeddingContext() to get the EmbeddingContext object;
• Use the EmbeddingContext object to call Library home page APIs.

A piece of example code could be like this:

try {
  const dossier = await microstrategy.dossier.create({
    url: "{YOUR_DOSSIER_URL}",
    placeholder: document.getElementById("dossierContainer"),
  });
  // ... Some manual actions to go to the Library home page
  const embeddingContext = dossier.getEmbeddingContext();
  // Use some Library home page APIs
  const myGroups = await embeddingContext.libraryPage.getAllMyGroups();
} catch (err) {
  // Your custom error handling logic here
}

The APIs under Library page object are as below.

Library page APIs

getAllMyGroups()

Description

This API is used for getting all the group items under "My Groups".

Class

LibraryPage

Return type

This API would return a Promise object that resolves to an object that contains the information of all groups contained in “My Groups“ and “Default Groups“. Its serialized JSON string is as below:

[
  {
    "id": "D1ADEEDFC8D94008A8D66F27CB1EFF47",
    "name": "My Group A"
  },
  {
    "id": "0A88CE2CF43C4242A86A5439850C3EAA",
    "name": "My Group B"
  }
]

Example

const myGroups = await embeddingContext.libraryPage.getAllMyGroups();

getAllDefaultGroups()

Description

This API is used for getting all the group items under "Default Groups".

Class

LibraryPage

Return type

This API would return a Promise object that resolves to an object that contains the information of all groups contained in “My Groups“ and “Default Groups“. Its serialized JSON string is as below:

[
  {
    "id": "D1ADEEDFC8D94008A8D66F27CB1EFF47",
    "name": "Default Group A"
  },
  {
    "id": "0A88CE2CF43C4242A86A5439850C3EAA",
    "name": "Default Group B"
  }
]

Example

const myGroups = await embeddingContext.libraryPage.getAllDefaultGroups();

setNavigationBarEnabled(enabled: Boolean)

Description

This API is used for enabling or disabling the navigation bar dynamically.

Class

LibraryPage

Input parameters

• enabled:

  Data Type

  Boolean

  Required?

  Yes

Return type

This API would return a Promise object that resolves to nothing.

Example

await embeddingContext.libraryPage.setNavigationBarEnabled(true);

API errors

This API would report an error in these 2 cases:

• When enabled value isn't boolean.
• When enabled is true, and the navigation bar is disabled by the application settings.

setSidebarVisibility(shown: Boolean)

Description

This API is used for showing or hiding the sidebar.

Class

LibraryPage

Input parameters

• shown:

  Data Type

  Boolean

  Required?

  Yes

Return type

This API would return a Promise object that resolves to nothing.

Example

await embeddingContext.libraryPage.setSidebarVisibility(true);

API errors

This API would report an error in these 2 cases:

• When shown value isn't boolean.
• When shown is true, and the sidebar is disabled by the application settings.