Enables scripted content fragments to use Emoticons
Methods
Create
Create a new emoticon
Velocity
#set($emoticonResponse = $core_v2_emoticon.Create($code, $url, $description))
JavaScript
var emoticonResponse = core_v2_emoticon.Create(code, url, description);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
code | String | Code for the emoticon | Required | ||
url | String | URL of emoticon image | Required | ||
description | String | Description of the emoticon | Required |
Returns
Delete
Deletes an emoticon
Velocity
#set($additionalInfoResponse = $core_v2_emoticon.Delete($id))
JavaScript
var additionalInfoResponse = core_v2_emoticon.Delete(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id of the emoticon | Required |
Returns
Get
Gets an emoticon
Velocity
#set($emoticonResponse = $core_v2_emoticon.Get($id))
JavaScript
var emoticonResponse = core_v2_emoticon.Get(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id of the emoticon | Required |
Returns
List
Lists all emoticons
Velocity
#set($apiListResponse = $core_v2_emoticon.List())
JavaScript
var apiListResponse = core_v2_emoticon.List();
Returns
Update
Update an existing emoticon
Velocity
#set($emoticonResponse = $core_v2_emoticon.Update($id, "%{ Code = $codeArg, Description = $descriptionArg, Url = $urlArg }"))
JavaScript
var emoticonResponse = core_v2_emoticon.Update(id, { Code: codeArg, Description: descriptionArg, Url: urlArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id of the emoticon | Required | ||
options | Options | Set of optional parameters including: | Required | ||
Code | String | Code for the emoticon | Optional | ||
Description | String | Description of the emoticon | Optional | ||
Url | String | URL of emoticon image | Optional |