Package de.xima.fc.user_portal.api.provider.spec

Interface IPortalsApi

  • public interface IPortalsApi
    High-level methods for retrieving available user portals.
    Since:
    8.2.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • byAlias

        IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource> byAlias​(IUserPortalInvocationContext ctx,
                                                                                                 String portalAlias)
        Gets a user portal by its alias.
        Parameters:
        ctx - Invocation context for communicating with the user portal REST API.
        portalAlias - The alias of the portal to retrieve.
        Returns:
        The user portal with the given alias, null if no such portal exists.

      • byUuid

        IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource> byUuid​(IUserPortalInvocationContext ctx,
                                                                                                UUID portalUuid)
        Gets a user portal by its uuid.
        Parameters:
        ctx - Invocation context for communicating with the user portal REST API.
        portalUuid - the UUID of the portal to retrieve.
        Returns:
        The user portal with the given alias, null if no such portal exists.