• Publicity: Public Only All

content-extlink-procs.tcl

Procedures for content_extlink

Location:
packages/acs-content-repository/tcl/content-extlink-procs.tcl
Created:
2004-06-09
Author:
Dave Bauer <dave@thedesignexperience.org>
CVS Identification:
$Id: content-extlink-procs.tcl,v 1.12.2.1 2020/08/26 15:17:29 antoniop Exp $

Procedures in this file

Detailed information

content::extlink::copy (public)

 content::extlink::copy -extlink_id extlink_id \
    -target_folder_id target_folder_id -creation_user creation_user \
    [ -creation_ip creation_ip ]
Switches:
-extlink_id (required)
extlink to copy
-target_folder_id (required)
folder to copy extlink into
-creation_user (required)
-creation_ip (optional)
Returns:
0

Testcases:
content_extlink

content::extlink::delete (public)

 content::extlink::delete -extlink_id extlink_id
Switches:
-extlink_id (required)
item_id of extlink to delete
Returns:
0

Testcases:
content_extlink

content::extlink::edit (public)

 content::extlink::edit -extlink_id extlink_id -url url -label label \
    -description description

Edit an existing external link. The parameters are required because it is assumed that the caller will be pulling the existing values out of the database before editing them.

Switches:
-extlink_id (required)
Optional pre-assigned object_id for the link
-url (required)
The URL of the external resource
-label (required)
Label for the extlink (defaults to the URL)
-description (required)
An extended description of the link (defaults to NULL)

Testcases:
content_extlink

content::extlink::is_extlink (public)

 content::extlink::is_extlink -item_id item_id
Switches:
-item_id (required)
item_id to check
Returns:
1 if extlink, otherwise 0

Testcases:
content_extlink, attachments_name_api

content::extlink::name (public)

 content::extlink::name -item_id item_id

Returns the name of an extlink

Switches:
-item_id (required)
The object id of the item to check.

Testcases:
content_extlink, attachments_name_api

content::extlink::new (public)

 content::extlink::new [ -extlink_id extlink_id ] -url url \
    -parent_id parent_id [ -name name ] [ -label label ] \
    [ -description description ] [ -package_id package_id ]

Create a new external link.

Switches:
-extlink_id (optional)
-url (required)
-parent_id (required)
-name (optional)
-label (optional)
-description (optional)
-package_id (optional)
Returns:
0

Testcases:
content_extlink
[ show source ]