Clipboard
The Clipboard service is used to manage user-specific clipboard data on the Platform server. The server-side clipboard enables clipboard access across multiple devices and securely maintains data by user; accessible only to the user who copied the data. The service also manages clipboard data conversion to other formats.
The clipboard capabilities of the API includes the following REST calls:
addClipboardData
|
Function |
Add data to clipboard. |
||
|
Description |
This request adds data to the logged-in user's clipboard and returns info about the data added . |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
or
|
string |
The content type Id or Name of the data. |
|
|
|
string |
The mimeType of the data. |
|
|
|
string |
The data stream. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
addFormattedData
|
Function |
Add formatted data. |
||
|
Description |
This request adds formatted-data to the logged-in user’s clipboard for the data corresponding to the data Id. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The data stream. |
|
|
|
string |
The format of the data. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getAllClipboardChannelsMapping
|
Function |
Get all clipboard cannel mappings. |
||
|
Description |
This request retrieves all of the clipboard format to channel mappings. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getClipboardData
|
Function |
To get the clipboard data. |
||
|
Type |
Get |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Optional value used to set content-disposition header value in response |
|
|
|
string |
output stream onto which output is to be written. This parameter is applicable only for the local invocations |
|
|
Returns |
Returns the data associated with the given dataId. |
||
|
Examples |
URL:
|
||
getAllClipboardDataInfos
|
Function |
Get all clipboard data information. |
||
|
Description |
This request fetches information about all the data present in the logged-in user’s clipboard. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
(Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllClipboardFormats
|
Function |
Get all clipboard formats |
||
|
Description |
This request returns all the data formats supported for clipboard data. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getClipboardDataInfo
|
Function |
Get clipboard data information. |
||
|
Description |
This request fetches information about the logged-in user’s clipboard data using the data Id. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
(Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getClipboardChannelsMapping
|
Function |
Get clipboard channel mappings for content type. |
||
|
Description |
This request returns the cipboard format to channel mappings based on the content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The content type.(Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getFormattedData
|
Function |
Get formatted data. |
||
|
Description |
This request retrieves formatted data based on the data Id and format. The formatted data is retrieved by using default Channel Mappings if no publishing channel parameter is specified. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The format in which clipboard data is to be retrieved. |
|
|
|
string |
The publishing channel Id. |
|
|
|
string |
The publishing channel parameters. |
|
|
|
|
The content disposition value to be set on the http response header. |
|
|
|
string |
The output stream onto which output is to be written (for local API invocations). |
|
|
Returns |
Returns a stream of formatted data. |
||
|
Examples |
URL:
Result: A filestream of the required output format based on given parameters. |
||
getLatestClipboardData
|
Function |
Get latest clipboard data. |
||
|
Description |
This request retrieves the latest data that was added to the logged-in user’s clipboard. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The content disposition value to be set on the http response headers. |
|
|
|
string |
The output stream onto which output is to be written (for local API invocations). |
|
|
Returns |
Returns a stream of copied data into server. |
||
|
Examples |
URL:
Result: A filestream of the latest copied data. |
||
getLatestClipboardDataInfo
|
Function |
Get latest clipboard data information. |
||
|
Description |
This request fetches information about the latest data that was added to the logged-in user’s clipboard. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
|
|
|
|
boolean |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getLatestFormattedData
|
Function |
Get latest formatted data. |
||
|
Description |
This request retrieves the latest data added to the logged-in user’s clipboard in the specified format. The formatted data is retrieved by using default Channel Mappings if no publishing channel parameter is specified. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The format in which clipboard data is to be retrieved. |
|
|
|
string |
The publishing channel Id. |
|
|
|
string |
The publishing channel parameters. |
|
|
|
|
The content disposition value to be set on the http response header. |
|
|
|
string |
The output stream onto which output is to be written (for local API invocations). |
|
|
Returns |
Returns a stream of formatted data. |
||
|
Examples |
URL:
Result: A filestream of the required output format based on given parameters. |
||
promoteClipboardDataToAsset
|
Function |
Promote clipboard data to asset |
||
|
Description |
This request promotes the user's clipboard data to Platform's asset. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
boolean |
|
|
|
|
string |
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
RESULT:
|
||
