core_v2_emoticon Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:30 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:30

Enables scripted content fragments to use Emoticons

Create

Create a new emoticon

#set($emoticonResponse = $core_v2_emoticon.Create($code, $url, $description))

var emoticonResponse = core_v2_emoticon.Create(code, url, description);

Name	Type	Description	Required
code	`String`	Code for the emoticon	Required
url	`String`	URL of emoticon image	Required
description	`String`	Description of the emoticon	Required

[[emoticon]]

Deletes an emoticon

#set($additionalInfoResponse = $core_v2_emoticon.Delete($id))

var additionalInfoResponse = core_v2_emoticon.Delete(id);

Name	Type	Description	Required	Default	Options
id	`Int32`	Id of the emoticon	Required

[[AdditionalInfo Script API Type|AdditionalInfo]]

Gets an emoticon

#set($emoticonResponse = $core_v2_emoticon.Get($id))

var emoticonResponse = core_v2_emoticon.Get(id);

Name	Type	Description	Required	Default	Options
id	`Int32`	Id of the emoticon	Required

[[emoticon]]

Lists all emoticons

#set($apiListResponse = $core_v2_emoticon.List())

var apiListResponse = core_v2_emoticon.List();

[[ApiList Script API Type|ApiList]] of [[emoticon]]

Update an existing emoticon

#set($emoticonResponse = $core_v2_emoticon.Update($id, "%{ Code = $codeArg, Description = $descriptionArg, Url = $urlArg }"))

var emoticonResponse = core_v2_emoticon.Update(id, { Code: codeArg, Description: descriptionArg, Url: urlArg });

Name	Type	Description	Required
id	`Int32`	Id of the emoticon	Required
Code	`String`	Code for the emoticon	Optional
Description	`String`	Description of the emoticon	Optional
Url	`String`	URL of emoticon image	Optional

[[emoticon]]