TileAppFilter Class Methods

In this section, the TileAppFilter class methods are presented in alphabetical order.

Syntax

IsTileVisible(&CREF)

Description

Implement the IsTileVisible method to define application business logic that determines whether a tile is displayed or hidden on a fluid homepage or fluid dashboard.

The use of the IsTileVisible method has the following limitations:

  • In a cluster environment, the TileAppFilter.IsTileVisible logic is only available if you are logged in to the node where the tile is defined directly. If the tile is added as a remote node, it will behave like a conventional tile, and the TileAppFilter.IsTileVisible logic is not executed.

  • In fluid homepages, the TileAppFilter.IsTileVisible logic is only executed once during a login session when the tile is initially loaded (typically at login) as the homepages are cached. However, dashboards evaluate the TileAppFilter.IsTileVisible logic every time the dashboard is loaded.

Parameters

Parameter

Description

&CREF

Specifies the portal object for the tile definition as an already instantiated ApiObject object.

Returns

A boolean value:

  • True if the tile is to be displayed.

  • False if the tile is hidden and not to be displayed.

Example

method IsTileVisible
   /+ &cref as ApiObject +/
   /+ Returns Boolean +/
   /+ Extends/implements PTGP_APPCLASS_TILE:API:TileAppFilter.IsTileVisible +/
   
   /* Application-specific logic to hide or show a tile. */
   If IsUserInPermissionList("PTPT1000", "PTPT1600") And 
         &cref.Name <> "PORTAL_ROOT_OBJECT" Then
      Return True;
   Else
      Return False;
   End-If;
end-method;