Skip to content

README.md

Latest commit

 

History

History
149 lines (106 loc) · 4.13 KB

README.md

File metadata and controls

149 lines (106 loc) · 4.13 KB

FastComments Java Core

The FastComments Java Core package provides the foundational components for integrating FastComments functionality into Java applications and Android applications. This package contains the core models, configurations, and utilities required to work with the FastComments platform.

Overview

The core package serves as the base for FastComments Java implementations, providing:

  • Comment widget configuration
  • SSO (Single Sign-On) implementation
  • Callback interfaces for events
  • Core models for data representation

Installation

Maven

Add the Repsy repository to your project's POM:

<repositories>
    <repository>
        <id>repsy</id>
        <name>FastComments Maven Repository on Repsy</name>
        <url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
    </repository>
</repositories>

Then add the dependency:

<dependency>
  <groupId>com.fastcomments</groupId>
  <artifactId>core</artifactId>
  <version>0.0.2</version>
</dependency>

Gradle

Add the Repsy repository to your build.gradle file:

repositories {
    mavenCentral()
    maven {
        url "https://repo.repsy.io/mvn/winrid/fastcomments"
    }
}

Then add the dependency:

implementation 'com.fastcomments:core:0.0.2'

Key Components

CommentWidgetConfig

The CommentWidgetConfig class provides configuration options for the FastComments widget. It includes settings for:

  • Tenant identification
  • Page/URL configuration
  • UI customization
  • Feature toggles
  • Authentication settings
  • Callback registration

Example usage:

CommentWidgetConfig config = new CommentWidgetConfig("your-tenant-id", "page-url-id", 
                                                    "https://example.com/article", 
                                                    "example.com", 
                                                    "Article Title");
// Configure additional options
config.showLiveRightAway = true;

SSO Integration

The core package provides SSO (Single Sign-On) support through the following classes:

  • FastCommentsSSO: Main class for SSO configuration
  • SecureSSOPayload: For secure SSO implementation
  • SecureSSOUserData: User data for secure SSO
  • SimpleSSOUserData: Simplified user data for basic SSO

Example Secure SSO Usage Server-Side:

// ---- BEGIN SERVER SIDE
SecureSSOUserData userData = new SecureSSOUserData("user-123", "user@example.com", "Example User", "https://example.com/avatar.jpg");

// Create SSO configuration
FastCommentsSSO sso = FastCommentsSSO.createSecure(myApiKey, userData);
String ssoString = sso.prepareToSend(); // send to client
// ---- END SERVER SIDE

Usage With API, or Client SDK:

// ... create user data for SSO (server side!)

// then call the comments api with it
publicApi.getComments(config.tenantId, config.urlId).sso(ssoString)

// ... or add to the widget config for the Android SDK
config.sso = ssoString;

Example Simple SSO usage:

// Create user data for SSO (usually client side, less secure)
SimpleSSOUserData userData = new SimpleSSOUserData("ExampleUser", "user@example.com", "https://example.com/avatar.jpg");

// Create SSO configuration
FastCommentsSSO sso = new FastCommentsSSO(userData);

// then call the comments api with it
publicApi.getComments(config.tenantId, config.urlId).sso(sso.createToken())

// ... or add to the widget config for the Android SDK
config.sso = sso.createToken();

Callbacks

The core package includes several callback interfaces for handling events:

  • CommentFlaggedCallback: Called when a comment is flagged
  • CommentSubmitStartCallback: Called when a comment submission starts
  • InstanceCallback: Generic instance callback
  • OpenProfileCallback: Called when a user profile should be opened
  • UserBlockedCallback: Called when a user is blocked
  • VoteSuccessCallback: Called when a vote is successful

Integration with Android SDK

The core package is designed to work seamlessly with the FastComments Android SDK, providing the foundation for Android applications that want to integrate FastComments functionality.

Requirements

  • Java 8 or higher