How To
Documentation
    Learn More

      CollaborationService

      Description

      Appkit service for accessing Appkit Collaboration API's

      Methods

      • delete(annotation, platform, id)

        Deletes an annotation

        Parameters
        ParamTypeDetails
        annotationstring

        The type of collaboration annotation to delete. Valid values are:-
        comment - For deleting a comment.
        bookmark - For deleting a bookmark.
        topic - For deleting a topic.
        link - For deleting a like.
        saved-query - For deleting a saved-query.

        platformstring

        The name of the platform.

        idstring

        The ID of the annotation to be deleted.

        Returns
        HttpPromise

        Returns a promise which will resolve depending on the response from the API.

        Example

        CollaborationService.delete('comment', 'platform', 123456);

      • getCommentAddedEventName(target, topic, collection)

        Method for returning the event emitted when a comment is added

        Parameters
        ParamTypeDetails
        targetstring

        The comment target.

        topic
        (optional)
        string

        The topic associated to the comment.

        collection
        (optional)
        string

        The collection associated to the comment.

        Returns
        string

        The event name that will be emitted.

        Example

        CollaborationService.getCommentAddedEventName(target, collection, topic);

      • post(annotation, platform, data)

        Creates an annotation

        Parameters
        ParamTypeDetails
        annotationstring

        The type of collaboration annotation to delete. Valid values are:-
        comment - For creating a comment.
        bookmark - For creating a bookmark.
        topic - For creating a topic.
        link - For creating a like.
        saved-query - For creating a saved-query.

        platformstring

        The name of the platform.

        dataobject

        The data object for creating the required annotation.

        Returns
        HttpPromise

        Returns a promise which will resolve depending on the response from the API.

        Example

        CollaborationService.post('comment', 'platform', data);

      • query(annotation, platform, target, collection, topic, results)

        Gets an array of Collaboration Annotations (comments, likes, topics or bookmarks) based on the options provided.

        Parameters
        ParamTypeDetails
        annotationstring

        The type of collaboration annotation you are searching for. Valid values are:-
        comments - Returns a list of comments
        bookmarks - Returns a list of bookmarks
        topics - Returns a list of topics
        links - Returns a list of likes.
        saved-queries - Returns a list of saved-queries.

        platformstring

        The name of the platform.

        target
        (optional)
        string

        When provided it will return only annotations associated with this target (not applicable to topics).

        collection
        (optional)
        string

        When provided it will return only annotations associated with this collection (not applicable to topics).

        topic
        (optional)
        string

        When provided it will return only annotations associated with this topic (not applicable to topics).

        results
        (optional)
        number

        The number of annotations to return.

        Returns
        HttpPromise

        Returns a promise which will resolve depending on the response from the API.

        Example

        CollaborationService.query('comments', 'platform', 'foo-bar');