Interface IPortalsApi
public interface IPortalsApi
High-level methods for retrieving available user portals.
- Since:
- 8.2.0
- Author:
- XIMA MEDIA GmbH
-
Method Summary
Modifier and TypeMethodDescriptionbyAlias(IUserPortalInvocationContext ctx, String portalAlias) Gets a user portal by its alias.byUuid(IUserPortalInvocationContext ctx, UUID portalUuid) Gets a user portal by its uuid.
-
Method Details
-
byAlias
IUserPortalResponse<DetailedUserPortalResource> 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,
nullif no such portal exists.
-
byUuid
IUserPortalResponse<DetailedUserPortalResource> 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,
nullif no such portal exists.
-