search string side menu

External portals

Hierarchy

  • Portals

Methods

get

  • get(code: String): Promise<Portal | undefined>

  • Get portal by worskspace code.

    Example: 

    const portal = await System.portals.get(Namespace. code);

    Parameters

    • code: String

      Workspace code.

    Returns Promise<Portal | undefined>

getAvailableForUser

  • Get a list of portals available to the user.

    Example: 

    const user = System.users.getCurrentUser();
const  portals = await System.portals.getAvailableForUser(user);

    Parameters

    Returns Promise<Portal[]>

list

  • Get a list of the company's portals.

    Example: 

    const portals = await System.portals.list();

    Returns Promise<Portal[]>