Package zendesk.support

Interface SupportBlipsProvider


  • public interface SupportBlipsProvider
    A Provider for tracking user actions and page views.

    This is used internally by the Support SDK and should not be called directly by an integrator.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void articleView(Article article)
      Tracks a view of a Help Center article as a PageView blip.
      void articleVote(java.lang.Long articleId, int vote)
      Tracks a vote on a Help Center article as a UserAction blip.
      void helpCenterSearch(java.lang.String query)
      Tracks a Help Center search as a UserAction blip.
      void requestCreated(java.lang.String requestId)
      Tracks creation of a Support request as a UserAction blip.
      void requestListViewed()
      Tracks a user's viewing of the request list as a UserAction blip.
      void requestUpdated(java.lang.String requestId)
      Tracks a user's update of a Support request as a UserAction blip.
      void requestViewed(java.lang.String requestId)
      Tracks a user's viewing of a Support request as a UserAction blip.
      void supportSdkInit()
      Tracks a Support SDK initialisation event as a UserAction blip.

    • Method Detail

      • supportSdkInit

        void supportSdkInit()
        Tracks a Support SDK initialisation event as a UserAction blip.

      • requestCreated

        void requestCreated(java.lang.String requestId)
        Tracks creation of a Support request as a UserAction blip.
        Parameters:
        requestId - the ID of the created request.

      • requestUpdated

        void requestUpdated(java.lang.String requestId)
        Tracks a user's update of a Support request as a UserAction blip.
        Parameters:
        requestId - the ID of the updated request.

      • requestViewed

        void requestViewed(java.lang.String requestId)
        Tracks a user's viewing of a Support request as a UserAction blip.
        Parameters:
        requestId - the ID of the viewed request.

      • requestListViewed

        void requestListViewed()
        Tracks a user's viewing of the request list as a UserAction blip.

      • helpCenterSearch

        void helpCenterSearch(java.lang.String query)
        Tracks a Help Center search as a UserAction blip.
        Parameters:
        query - the search query to be tracked in the Blip

      • articleView

        void articleView(Article article)
        Tracks a view of a Help Center article as a PageView blip.
        Parameters:
        article - the viewed article.

      • articleVote

        void articleVote(java.lang.Long articleId,
                 int vote)
        Tracks a vote on a Help Center article as a UserAction blip.
        Parameters:
        articleId - the ID of the article on which the vote has been cast
        vote - an integer representation of the vote's direction. +1 for an upvote, -1 for a downvote, 0 for a deleted vote.