Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_submittableEditor Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

core_v2_submittableEditor Script API


Enables scripted content fragments to render and interact with a content editor supporting immediate submission.

  • GetAttachOnChangeScript
  • GetAttachOnKeyDownScript
  • GetAttachOnReadyScript
  • GetBookmarkScript
  • GetContentScript
  • GetContextScript
  • GetFocusScript
  • GetInsertContentScript
  • GetMoveScript
  • GetRemoveScript
  • GetUpdateContentScript
  • Render
  • SetContextScript

Methods

GetAttachOnChangeScript

Gets a Javascript script that, when executed, registers a javascript function to be executed when an editor's content changes

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetAttachOnChangeScript($id, $function))

JavaScript

var stringResponse = core_v2_submittableEditor.GetAttachOnChangeScript(id, function);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
functionStringJavascript function to be executed when the editor's content changesRequired

Returns

String

GetAttachOnKeyDownScript

Gets a Javascript script that, when executed, registers a javascript function to be executed when an editor's content changes. The function is provided the browser event object to inspect/cancel the keystroke.

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetAttachOnKeyDownScript($id, $function))

JavaScript

var stringResponse = core_v2_submittableEditor.GetAttachOnKeyDownScript(id, function);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
functionStringJavascript function to be executed when the editor's content changesRequired

Returns

String

GetAttachOnReadyScript

Gets a Javascript script that, when executed, registers a javascript function to be executed when an editor is initialized.

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetAttachOnReadyScript($id, $function))

JavaScript

var stringResponse = core_v2_submittableEditor.GetAttachOnReadyScript(id, function);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
functionStringJavascript function to be executed when the editor is initializedRequired

Returns

String

GetBookmarkScript

Gets a Javascript script that, when executed, saves the current cursor location within an editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetBookmarkScript($id))

JavaScript

var stringResponse = core_v2_submittableEditor.GetBookmarkScript(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired

Returns

String

GetContentScript

Gets a Javascript script that, when executed, returns the contents of an editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetContentScript($id))

JavaScript

var stringResponse = core_v2_submittableEditor.GetContentScript(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired

Returns

String

GetContextScript

Gets a Javascript script that, when executed, returns the current context identifier for the editor.

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetContextScript($id))

JavaScript

var stringResponse = core_v2_submittableEditor.GetContextScript(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringIdRequired

Returns

String

GetFocusScript

Gets a Javascript script that, when executed, sets the focus on an editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetFocusScript($id))

JavaScript

var stringResponse = core_v2_submittableEditor.GetFocusScript(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired

Returns

String

GetInsertContentScript

Gets a Javascript script that, when executed, inserts HTML into the current cursor location within an editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetInsertContentScript($id, $contentVariableName))

JavaScript

var stringResponse = core_v2_submittableEditor.GetInsertContentScript(id, contentVariableName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
contentVariableNameStringJavascript variable name containing the HTML to insertRequired

Returns

String

GetMoveScript

Gets a Javascript script that, when executed, moves the editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetMoveScript($id, $target))

JavaScript

var stringResponse = core_v2_submittableEditor.GetMoveScript(id, target);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
targetStringJavascript variable name containing the selector or DOM element to move the editor toRequired

Returns

String

GetRemoveScript

Gets a Javascript script that, when executed, removes the editor.

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetRemoveScript($id))

JavaScript

var stringResponse = core_v2_submittableEditor.GetRemoveScript(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringIdRequired

Returns

String

GetUpdateContentScript

Gets a Javascript script that, when executed, replaces the content of an editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.GetUpdateContentScript($id, $contentVariableName))

JavaScript

var stringResponse = core_v2_submittableEditor.GetUpdateContentScript(id, contentVariableName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringID of the editorRequired
contentVariableNameStringJavascript variable name containing the HTML to assign to the editorRequired

Returns

String

Render

Renders a rich text editor

Velocity

#set($stringResponse = $core_v2_submittableEditor.Render($id, $submitFunction, "%{ AfterHtml = $afterHtmlArg, ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, AutoResize = $autoResizeArg, BeforeHtml = $beforeHtmlArg, ContentTypeId = $contentTypeIdArg, EnableEnterToSubmitToggle = $enableEnterToSubmitToggleArg, EnterToSubmitPrompt = $enterToSubmitPromptArg, Height = $heightArg, Placeholder = $placeholderArg, SubmitLabel = $submitLabelArg, Value = $valueArg, Width = $widthArg }"))

JavaScript

var stringResponse = core_v2_submittableEditor.Render(id, submitFunction, { AfterHtml: afterHtmlArg, ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, AutoResize: autoResizeArg, BeforeHtml: beforeHtmlArg, ContentTypeId: contentTypeIdArg, EnableEnterToSubmitToggle: enableEnterToSubmitToggleArg, EnterToSubmitPrompt: enterToSubmitPromptArg, Height: heightArg, Placeholder: placeholderArg, SubmitLabel: submitLabelArg, Value: valueArg, Width: widthArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringId to apply to the editor in order to reference it laterRequired
submitFunctionStringJavascript function to be executed when the editor's content changesRequired
optionsOptionsSet of optional parameters including:Required
AfterHtmlStringHTML to rneder after the submit UI in the editor.Optional
ApplicationIdGuidIdentifier of the application in which content is being editedOptional
ApplicationTypeIdGuidIdentifier of the type of application in which content is being editedOptional
AutoResizeBooleanEnables the editor to autoresize in height.OptionalTrue
BeforeHtmlStringHTML to render before the submit UI in the editor.Optional
ContentTypeIdGuidIdentifier of the type of content being editedOptional
EnableEnterToSubmitToggleBooleanEnables toggling enter to submit, if enabled by the site.OptionalTrue
EnterToSubmitPromptStringText label to enable enter to submitOptional
HeightStringHeight of the editor (CSS unit)Optional
PlaceholderStringPlaceholder text rendered within the editor when blurred and without a value.Optional
SubmitLabelStringExplicit submission button labelOptional
ValueStringHTML value of the editorOptional
WidthStringWidth of the editor (CSS unit)Optional

Returns

String

SetContextScript

Gets a Javascript script that, when executed, sets the context identifier for the editor. When changed, the content of the editor is cleared or the last backup of content for the new context identifier is restored.

Velocity

#set($stringResponse = $core_v2_submittableEditor.SetContextScript($id, $contextIdVariableName))

JavaScript

var stringResponse = core_v2_submittableEditor.SetContextScript(id, contextIdVariableName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringIdRequired
contextIdVariableNameStringContext Id Variable NameRequired

Returns

String


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community