Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 11.x
  • Verint Community
Verint Community 11.x
API Documentation evolutionBookmark jQuery Plugin
  • 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
      • +Client Messages
      • +Composer Plugins
      • +JavaScript API Modules
      • +jQuery Events
      • -jQuery Plugins
        • dynamicForm jQuery Plugin
        • evolutionBookmark jQuery Plugin
        • evolutionCodeEditor jQuery Plugin
        • evolutionComposer jQuery Plugin
        • evolutionFeature jQuery Plugin
        • evolutionHighlight jQuery Plugin
        • evolutionHtmlEditor jQuery Plugin
        • evolutionInlineTagEditor jQuery Plugin
        • evolutionLike jQuery Plugin
        • evolutionMasonry jQuery Plugin
        • evolutionModerate jQuery Plugin
        • evolutionPager jQuery Plugin
        • evolutionProgressIndicator jQuery Plugin
        • evolutionResize jQuery Plugin
        • evolutionScrollSlider jQuery Plugin
        • evolutionSqueezeText jQuery Plugin
        • evolutionStarRating jQuery Plugin
        • evolutionTagTextBox jQuery Plugin
        • evolutionTextEditor jQuery Plugin
        • evolutionTheater jQuery Plugin
        • evolutionTip jQuery Plugin
        • evolutionToggleLink jQuery Plugin
        • evolutionTransform jQuery Plugin
        • evolutionUserFileTextBox jQuery Plugin
        • evolutionValidation jQuery Plugin
        • glowColorSelector jQuery Plugin
        • glowDropDownList jQuery Plugin
        • glowLookUptextBox jQuery Plugin
        • glowMultiUpload jQuery Plugin
        • glowOrderedList jQuery Plugin
        • glowPatternedTextBox jQuery Plugin
        • glowPopUpMenu jQuery Plugin
        • glowPopUpPanel jQuery Plugin
        • glowTabbedPanes jQuery Plugin
        • glowTabSet jQuery Plugin
        • glowTransition jQuery Plugin
        • glowTree jQuery Plugin
        • glowUpload jQuery Plugin
        • uilinks jQuery Plugin
      • +UI Components
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • +Script APIs

evolutionBookmark jQuery Plugin


jQuery.fn.evolutionBookmark

This plugin supports rendering a bookmark toggle link, allowing the user to bookmark or unbookmark content.

Usage

$('SELECTOR').evolutionBookmark(options)

where 'SELECTOR' is a span.

Options

  • contentId: (string) content ID
  • contentTypeId: (string) content type ID
  • typeId: (string) bookmark type ID
  • contentTypeName: (string) the name of the content type
  • initialState: (boolean) content is bookmarked
    • default false
  • onBookmark: (function) callback function when a selection is made. The function is passed contentId, contentTypeId, typeId, and a callback function to call when processing is complete
  • onUnbookmark: (function) callback function when a selection is made. The function is passed contentId, contentTypeId, typeId, and a callback function to call when processing is complete
  • deleteBookmarkText: Label for the unbookmark link. {content_type_name} is replaced with the content's type name.
    • default 'Unbookmark {content_type_name}'
  • addBookmarkText: Label for the bookmark link. {content_type_name} is replaced with the content's type name.
    • default 'Bookmark this {content_type_name}'
  • processingText: Label for the link when it is processing. {content_type_name} is replaced with the content's type name.
    • default '...'
  • addBookmarkCssClass: CSS class to apply to the bookmark link.
    • default 'internal-link favorite-off'
  • deleteBookmarkCssClass: CSS class to apply to the unbookmark link.
    • default 'internal-link favorite-on'
  • processingCssCLass: CSS class to apply to the link when processing.
    • default 'internal-link processing'

Example

Given the following span to contain a bookmark control:

<span id="bookmarkControl"></span>

The following will initialize a bookmark control, using defaults for most options

var bookmarkControl = $('#bookmarkControl');
bookmarkControl.evolutionBookmark({
    initialState: true,  // content is bookmarked
    contentId: 'C512D1A1-ED6C-442D-BC9d-3587CD711D35',
    contentTypeId: 'F7D226AB-D59F-475C-9D22-4A79E3F0EC07',
    contentTypeName: 'Blog Post',
    onBookmark: function(contentId, contentTypeId, typeId, callback) {
        alert(contentId + ' bookmarked!');

        // ...perform AJAX-based saving of bookmark here...

        // After a successful save, callback to notify the bookmark plugin
        callback();
    },
    onUnbookmark: function(contentId, contentTypeId, typeId, callback) {
        alert(contentId + ' unbookmarked!');

        // ...perform AJAX-based saving of bookmark here...

        // After a successful save, callback to notify the bookmark plugin
        callback();
    }
});

  • 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 2022 Verint, Inc.
Powered by Verint Community