Skip to content

iEngage/java-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits

.settings

.settings

 
 

docs

docs

 
 

gradle/wrapper

gradle/wrapper

 
 

jar

jar

 
 

src

src

 
 

.classpath

.classpath

 
 

.gitignore

.gitignore

 
 

.project

.project

 
 

.swagger-codegen-ignore

.swagger-codegen-ignore

 
 

.travis.yml

.travis.yml

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

build.gradle

build.gradle

 
 

build.sbt

build.sbt

 
 

git_push.sh

git_push.sh

 
 

gradle.properties

gradle.properties

 
 

gradlew

gradlew

 
 

gradlew.bat

gradlew.bat

 
 

iEngage_JAVA_dependencies.zip

iEngage_JAVA_dependencies.zip

 
 

pom.xml

pom.xml

 
 

settings.gradle

settings.gradle

 
 

Repository files navigation

iEngage-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

Download the iEngage SDK jar.

To install the API client library to your local Maven repository, simply execute:

mvn install:install-file -Dfile="<Path to iengage_java_sdk.jar>" -DgroupId="io.iengage" -DartifactId=iengage-java-client -Dversion="1.0.0" -Dpackaging=jar -DgeneratePom=true

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.iengage</groupId>
    <artifactId>iengage-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>
<dependency>
      <groupId>com.squareup.okhttp</groupId>
      <artifactId>logging-interceptor</artifactId>
      <version>2.7.5</version>
</dependency>
<dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.6.2</version>
</dependency>
<dependency>
      <groupId>joda-time</groupId>
      <artifactId>joda-time</artifactId>
      <version>2.9.3</version>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.iengage:iengage-java-client:1.0.0"
compile "com.squareup.okhttp:okhttp:2.7.5"
compile "com.squareup.okhttp:logging-interceptor:2.7.5"
compile "com.google.code.gson:gson:2.6.2"
compile "joda-time:joda-time:2.9.3"

Alternatively you can download dependencies from here

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.iengage.*;
import com.iengage.auth.*;
import com.iengage.client.model.*;
import com.iengage.service.InteractionApi;

public class InteractionExample {
 	public static void main(String[] args) {
    
                ApiClient defaultClient = Configuration.getDefaultApiClient();
                OAuth oauthToken = (OAuth) defaultClient.getAuthentication("default");
                oauthToken.setAccessToken("YOUR ACCESS TOKEN");
 		InteractionApi apiInstance = new InteractionApi(defaultClient);
 		String loggedInUserId = "requesterId_example"; // String | User id of logged / authenticated user
 		String accessToken = null; // String | Unique session token for user. To get access token user will have to authenticate
 		String clientToken = "clientToken_example"; // String | Use the Client Token. Please generate it from the Applications section under the Production & Sandbox tabs
 		try {
 			InteractionInputModel body = new InteractionInputModel();
 			body.setInteractionTitle("Your message goes here"); //Change this
 			VerveResponseInteraction result = apiInstance.addInteraction(loggedInUserId, clientToken, body, accessToken);
 			System.out.println(result);
 		} catch (ApiException e) {
 			System.err.println("Exception when calling InteractionApi#addInteraction");
 			e.printStackTrace();
 		}
 	}
 }

Documentation for API Endpoints

All URIs are relative to https://api.iengage.io:8243/api/2.0

Class Method HTTP request Description
AugmentedIntelligenceApi classify POST /ml/classifier/classify Classifies using your classifier
AugmentedIntelligenceApi getEntities POST /ml/ner/classify Extracts entities from text
AugmentedIntelligenceApi getInteractionType POST /ml/interactionType Returns the type of interaction
AugmentedIntelligenceApi getKeywords POST /ml/keywords Returns the keywords of the sentence
AugmentedIntelligenceApi getPopularTag GET /analytics/popular/tags Get list of popular tag of interactions
AugmentedIntelligenceApi getSentiment GET /analytics/sentiments Get sentiment count of interactions
AugmentedIntelligenceApi getTagEntitySentiments GET /analytics/tag/entitySentiment Get list of tag entity sentiment
AugmentedIntelligenceApi sentiment POST /ml/sentiment Analyzes the sentiment of the content
BPMApi assignWFTask POST /bpm/tasks/{taskId}/assign Assign task
BPMApi completeWFTask POST /bpm/tasks/{taskId}/complete Complete task
BPMApi getBPMTasks GET /bpm/tasks/{taskId} Get task by task id
BPMApi getSearchTask GET /bpm/{userId}/tasks/name Get list of BPM task assigned to user
BPMApi getTasksByEntity GET /bpm/{userId}/tasks/{entityId} Get list of BPM task assigned to user
BPMApi getUserBPMTasks GET /bpm/{userId}/tasks Get list of BPM task assigned to user
BPMApi getUserRolesBPMTasks GET /bpm/{userId}/roles/tasks Get list of BPM task assigned to user roles
CollaborationApi addCommentBlog POST /collaborations/blogs/{blogId}/comments Comment on posted blog
CollaborationApi addCommentDiscussion POST /collaborations/discussions/{discussionId}/comments Comment on discussion
CollaborationApi deleteBlog DELETE /collaborations/blogs/{blogId} Delete blog
CollaborationApi deleteBlogComment DELETE /collaborations/blogs/comments/{commentId} Delete blog comment
CollaborationApi deleteDiscussion DELETE /collaborations/discussions/{discussionId} Delete discussion
CollaborationApi deleteDiscussionComment DELETE /collaborations/discussions/comments/{commentId} Delete discussion comment
CollaborationApi getBlogComments GET /collaborations/blogs/{blogId}/comments Get list of comments on blog
CollaborationApi getBlogs GET /collaborations/blogs Get list of blogs
CollaborationApi getDiscussionComments GET /collaborations/discussions/{discussionId}/comments Get list of comments on discussion
CollaborationApi getDiscussions GET /collaborations/discussions Get list of discussions
CollaborationApi getUserSubscribedBlogs GET /collaborations/blogs/{userId}/subscribe Get list of blogs subscribed by user
CollaborationApi getUserSubscribedDiscussions GET /collaborations/discussions/{userId}/subscribe Get list of discussions subscribed by user
CollaborationApi postBlog POST /collaborations/blogs Post blog
CollaborationApi startDiscussion POST /collaborations/discussions Start discussion
CollaborationApi subscribeBlog POST /collaborations/blogs/{blogId}/subscribe Subscribe blog
CollaborationApi subscribeDiscussion POST /collaborations/discussions/{discussionId}/subscribe Subscribe discussion
CollaborationApi unsubscribeBlog POST /collaborations/blogs/{blogId}/unsubscribe Unsubscribe blog
CollaborationApi unsubscribeDiscussion POST /collaborations/discussions/{discussionId}/unsubscribe Unsubscribe discussion
CollaborationApi updateBlog PUT /collaborations/blogs/{blogId} Update blog
CollaborationApi updateBlogComment PUT /collaborations/blogs/comments/{commentId} Update blog comment
CollaborationApi updateDiscussion PUT /collaborations/discussions/{discussionId} Update discussion
CollaborationApi updateDiscussionComment PUT /collaborations/discussions/comments/{commentId} Update discussion comment
GroupApi createGroup POST /groups Create group
GroupApi deleteGroup DELETE /groups/{groupId} Delete group
GroupApi followGroup POST /groups/{groupId}/follow Follow group
GroupApi getGroupFollowers GET /groups/{groupId}/followers Get the list of followers for the group
GroupApi getGroupIdeas GET /groups/{groupId}/ideas Get list of all ideas in a group
GroupApi getGroups GET /groups Get the list of groups visible for user
GroupApi getRecommendationGroup GET /groups/recommend Get list of recommended groups
GroupApi getUserFollowingGroups GET /groups/{userId}/following Get list of groups that a user is following
GroupApi searchGroups GET /groups/search Get list of matching groups
GroupApi unfollowGroup POST /groups/{groupId}/unfollow Unfollow group
GroupApi updateGroup PUT /groups/{groupId} Update group
IdeaApi deleteComment DELETE /ideas/comments/{commentId} Delete comment
IdeaApi deleteIdea DELETE /ideas/{ideaId} Delete idea
IdeaApi followIdea POST /ideas/{ideaId}/follow Follow idea
IdeaApi getAllIdeas GET /ideas Get list of Ideas
IdeaApi getFollowingIdeas GET /ideas/{userId}/following Get list of ideas that users are following
IdeaApi getGroupIdeas GET /ideas/getGroupIdeas Get list of ideas in group
IdeaApi getIdea GET /ideas/{ideaId} Get idea by id
IdeaApi getIdeaComment GET /ideas/{ideaId}/comments Get list of comments on idea
IdeaApi getIdeaFollowers GET /ideas/{ideaId}/followers Get list of followers for this idea
IdeaApi getIdeaRatingParameters GET /ideas/getIdeaRatingParameters Get rating parameters of idea by user
IdeaApi getIdeaRatings GET /ideas/getIdeaUserRating Get list of ideas that are rated by user
IdeaApi getRecommendIdeas GET /ideas/recommend Get the list of recommended ideas
IdeaApi getTopIdeas GET /ideas/top Get the list of top ideas
IdeaApi getUserIdeas GET /ideas/{userId}/shared Get list of ideas shared by user
IdeaApi getUserRateIdeas GET /ideas/{userId}/rated Get list of ideas rated by user
IdeaApi rateIdea POST /ideas/rateIdea Rate an idea
IdeaApi rateIdea_0 GET /ideas/rateIdeaByParameter Give rating on idea
IdeaApi searchIdeas GET /ideas/search Get list of matching ideas
IdeaApi shareFormIdea POST /ideas/attachment Share Idea with attachments
IdeaApi shareIdea POST /ideas Share idea
IdeaApi shareIdeaComment POST /ideas/{ideaId}/comments Comment on shared idea
IdeaApi unfollowIdea POST /ideas/{ideaId}/unfollow Unfollow idea
IdeaApi updateCommet PUT /ideas/comments/{commentId} Update comment
IdeaApi updateIdea PUT /ideas/{ideaId} Update idea
InteractionApi addInteraction POST /interactions Share interaction without attachment
InteractionApi addInteraction_0 POST /interactions/attachment Share interaction with attachment
InteractionApi addResponse POST /interactions/{interactionId}/responses Response the specified interaction
InteractionApi addResponse_0 POST /interactions/{interactionId}/responses/attachment Response the specified interaction
InteractionApi changeInteractionCategory PUT /interactions/{interactionId}/{categoryId} Change interaction category
InteractionApi changeInteractionType PUT /interactions/{interactionId}/type Change interaction type
InteractionApi createInteractionCategory POST /interactions/categories Create interaction category
InteractionApi deleteInteraction DELETE /interactions/{interactionId} Delete interaction
InteractionApi deleteInteractionCategory DELETE /interactions/categories/{categoryId} Delete interaction category
InteractionApi deleteResponse DELETE /interactions/responses/{responseId} Delete response
InteractionApi dislikeResponse POST /interactions/{interactionId}/responses/{responseId}/dislike Dislike response
InteractionApi getFriendsInteractions GET /interactions/friends Get list of interactions shared by friends
InteractionApi getInteraction GET /interactions/{interactionId} Get interaction by id
InteractionApi getInteractionCategories GET /interactions/categories Get the list of interaction categories
InteractionApi getInteractionsForUser GET /interactions Get list of all interactions visible to the user
InteractionApi getRecommendInteractions GET /interactions/recommend Get list of recommended interactions
InteractionApi getRecommendedInteractinsFromDB GET /interactions/{userId}/recommendedInteractions Get list of recommended interactions from DB
InteractionApi getRecommendedUsersFromDB GET /interactions/{interactionId}/recommendedUsers Get list of recommended Users from DB
InteractionApi getResponses GET /interactions/{interactionId}/responses Get list of responses by interactionId
InteractionApi getUserInteractions GET /interactions/{userId}/shared Get list of interactions shared by user
InteractionApi getUserSubscribedInteractionCategories GET /interactions/categories/{userId}/subscribe Get list of interaction categories subscribed by the user
InteractionApi getUserSubscribedInteractions GET /interactions/{userId}/subscribe Get list of interactions subscribed by user
InteractionApi likeResponse POST /interactions/{interactionId}/responses/{responseId}/like Like response
InteractionApi markAsAnResponse POST /interactions/{interactionId}/responses/{responseId}/mark Mark response as a response
InteractionApi searchInteractions GET /interactions/search Get list of matching interactions
InteractionApi subscribeInteractinCategory POST /interactions/categories/{categoryId}/subscribe Subscribe interaction category
InteractionApi subscribeInteraction POST /interactions/{interactionId}/subscribe Subscribe interaction
InteractionApi unmarkAsAnResponse POST /interactions/{interactionId}/responses/{responseId}/unmark Unmark response as a response
InteractionApi unsubscribeInteractinCategory POST /interactions/categories/{categoryId}/unsubscribe Unsubscribe interaction category
InteractionApi unsubscribeInteraction POST /interactions/{interactionId}/unsubscribe Unsubscribe interaction
InteractionApi updateInteraction PUT /interactions/{interactionId} Update interaction
InteractionApi updateInteractionCategory PUT /interactions/categories/{categoryId} Update interaction category
InteractionApi updateResponse PUT /interactions/responses/{responseId} Update response
NotificationApi addNotification POST /notifications Create custom notification
NotificationApi getNotifications GET /notifications Get list of notifications
NotificationApi markAllNotificationAsRead POST /notifications/read/all Mark all notification as read
NotificationApi markNotificationAsRead POST /notifications/read/{notificationId} Mark notification as read
NotificationApi notificationCount GET /notifications/count Get notifications count
ProjectManagementApi addMilestoneComment POST /milestones/{milestoneId}/comments Comment on milestone
ProjectManagementApi addTaskComment POST /milestones/tasks/{taskId}/comments Comment on task
ProjectManagementApi createMilestone POST /milestones Create milestone
ProjectManagementApi createTask POST /milestones/{milestoneId}/tasks Create task
ProjectManagementApi deleteMilestone DELETE /milestones/{milestoneId} Delete milestone
ProjectManagementApi deleteTask DELETE /milestones/tasks/{taskId} Delete task
ProjectManagementApi getMilestones GET /milestones Get list of milestones
ProjectManagementApi getMilestonesComments GET /milestones/{milestoneId}/comments Get list of comments written on Milestones
ProjectManagementApi getTaskComments GET /milestones/tasks/{taskId}/comments Get list of Comments written on task
ProjectManagementApi getUserTasks GET /milestones/tasks/{userId}/assigned Get list of task assigned to user
ProjectManagementApi updateMilestone PUT /milestones/{milestoneId} Update milestone
ProjectManagementApi updateTask PUT /milestones/tasks/{taskId} Update task
ProjectManagementApi updateTaskStatus PUT /milestones/tasks/{taskId}/status Update task status
RewardsApi getTopFriends GET /rewards/points/top/friends Get list of top friends
RewardsApi getTopUsers GET /rewards/points/top Get list of top users
RewardsApi getUserPoints GET /rewards/points/{userId} Get list of user points
SocialApi addFriend POST /social/friends/add Add Friend
SocialApi confirmFriendRequest POST /social/friends/request/action confirm/ignore friend request
SocialApi follow POST /social/follow Follow user
SocialApi getUser GET /social/users/{userId} Get user by id
SocialApi getUserDetail GET /social/userDetail Get user details
SocialApi getUserFollowers GET /social/followers/{userId} Get list of followers
SocialApi getUserFollowing GET /social/following/{userId} Get list of users that are being followed
SocialApi getUserFriends GET /social/friends{userId} Get list of friends
SocialApi removeFriend POST /social/friends/remove Remove friend
SocialApi requestFriend POST /social/friends/request Send friend request
SocialApi requestsForMe GET /social/friends/request Get list of friend requests
SocialApi unfollow POST /social/unfollow Unfollow user
UserAuthenticationApi addNotificationRegisteredId POST /devices Add device token
UserAuthenticationApi addUser POST /users Add/Register new user
UserAuthenticationApi authenticate GET /authenticate Authenticate User
UserAuthenticationApi changePassword PUT /users/password Change password
UserAuthenticationApi createAssociation POST /associations Create association
UserAuthenticationApi deleteUser DELETE /users/{userId} Delete user
UserAuthenticationApi getAssociations GET /associations Get list of associations
UserAuthenticationApi logout GET /logout Logout

Documentation for Models

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.

Author

iEngage.ai

About

Java/Android SDK for iEngage.io

iengage.io

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

4 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages