adm_shares_api

This document contains the API documentation for the adm_shares_api package.

Functions and Procedures

share_document

Shares a document with one or more users and/or groups

Signature:

procedure share_document (
  p_document_id in adm_document_shares.document_id%type,
  p_user_ids in varchar2,
  p_groups_ids in varchar2,
  p_share_role in adm_document_shares.share_role%type
);

Parameters:

Name	Direction	Type	Description
p_document_id	in	adm_document_shares.document_id%type	The ID of the document to be shared
p_user_ids	in	varchar2	A colon-separated list of user IDs, e.g. ‘1001:1002’. Null for none
p_groups_ids	in	varchar2	A colon-separated list of group IDs, e.g. ‘55:56’. Null for none
p_share_role	in	adm_document_shares.share_role%type	adm_access_control_api.c_view or c_edit

---

delete_share_document

Removes an existing document share

Signature:

procedure delete_share_document (
  p_doc_share_id in adm_document_shares.doc_share_id%type
);

Parameters:

Name	Direction	Type	Description
p_doc_share_id	in	adm_document_shares.doc_share_id%type	The ID of the document share to be deleted

---

share_folder

Shares a folder with one or more users and/or groups

Signature:

procedure share_folder (
  p_folder_id in adm_folders.folder_id%type,
  p_user_ids in varchar2,
  p_groups_ids in varchar2,
  p_share_role in adm_folder_shares.share_role%type
);

Parameters:

Name	Direction	Type	Description
p_folder_id	in	adm_folders.folder_id%type	The ID of the folder to be shared
p_user_ids	in	varchar2	A colon-separated list of user IDs, e.g. ‘1001:1002’. Null for none
p_groups_ids	in	varchar2	A colon-separated list of group IDs, e.g. ‘55:56’. Null for none
p_share_role	in	adm_folder_shares.share_role%type	adm_access_control_api.c_view or c_edit

---

delete_share_folder

Removes an existing folder share

Signature:

procedure delete_share_folder (
  p_folder_share_id in adm_folder_shares.folder_share_id%type
);

Parameters:

Name	Direction	Type	Description
p_folder_share_id	in	adm_folder_shares.folder_share_id%type	The ID of the folder share to be deleted

---