AddToHomePage method: ImageTile class

Syntax

AddToHomePage(HP_NAME, behavior)

Description

Use the AddToHomePage method to add the current tile to the specified fluid homepage or fluid dashboard.

Parameters

Parameter Description

HP_NAME

Specify the ID for the fluid homepage or fluid dashboard content reference definition as string value of up to 30 characters.

Note: The ID cannot include spaces or special characters and must not begin with a number.

behavior

Specify the behavior for this tile as a four-character string value.

The behavior parameter can have these values:

Value Behavior Description

4OPT

Optional

The tile is available to all users for users that have permissions to the tile, but it is not visible by default; users can add, move, or delete the tile.

3DEF

Optional default

The tile is visible to all users by default for users that have permissions to the tile; users can move or delete the tile.

Note: You must specify 3DEF if you wish to publish additional tiles to users who have already personalized this homepage or dashboard. See Portal Technology: (Fluid only) Using the Tile Publish Page to Publish Additional Tiles or Portal Technology: (Fluid only) Publishing Additional Tiles to Already Personalized Dashboards for more information.

2REQ

Required

The tile is visible to all users by default for users that have permissions to the tile; users can move the tile, however, they cannot delete it.

1FIX

Required-fixed

The tile is visible to all users by default for users that have permissions to the tile; however, users cannot move or delete it.

Returns

None.

Example

Note:

DEFAULT_LP is the ID for the My Homepage content reference definition.

import PTGP_APPCLASS_TILE:API:ImageTile;

Local PTGP_APPCLASS_TILE:API:ImageTile &t1 = create PTGP_APPCLASS_TILE:API:ImageTile("MY_TILE1");
&t1.AddToHomePage("DEFAULT_LP", "3DEF");