NexconnChatUISDK/ai.nexconn.chatui/NCChatUI

NCChatUI

public final class NCChatUI

NCChatUI — the main entry point for the ChatUI SDK.

Wraps nexconn-chat initialization and connection, provides a ChatUIFragmentFactory for all UI screens, and exposes an internal event bus for message and channel events.

Call initialize once in onCreate.
Call connect after a successful user login.
Use getFragmentFactory (or setFragmentFactory) to launch any screen.


// 1. Initialize in Application.onCreate
NCChatUI.initialize(new InitParams(context, "your-app-key"));

// 2. Connect after login
NCChatUI.connect(new ConnectParams("user-token"), (userId, error) -> {
    if (error == null) { // connected
    }
});

// 3. Replace any screen with a custom Fragment
NCChatUI.setFragmentFactory(new MyCustomFragmentFactory());

Functions

addCancelSendMediaMessageListener

public static void addCancelSendMediaMessageListener(Runnable listener)

Registers a cancel-send-media listener.

addChannelEventListener

public static void addChannelEventListener(ChannelEventListener listener)

Registers a channel event listener.

addMessageEventListener

public static void addMessageEventListener(MessageEventListener listener)

Registers a message event listener.

cancelSendMediaMessage

public static void cancelSendMediaMessage(Message message, ErrorHandler handler)

Cancels an in-progress media message upload.

connect

public static void connect(ConnectParams params, ConnectHandler handler)

Connects to the server using a business token.

createChannel

public static BaseChannel createChannel(ChannelIdentifier identifier)

Creates the appropriate BaseChannel subtype for the given ChannelIdentifier.

deleteLocalMessages

public static void deleteLocalMessages(ChannelIdentifier identifier, List<Message> messages, ErrorHandler handler)

Deletes messages from the local database only, then dispatches a DeleteEvent so that the message list refreshes immediately.

deleteMessageForAll

public static void deleteMessageForAll(ChannelIdentifier identifier, Message message, OperationHandler<Message> handler)

Recalls (deletes for all participants) a message and dispatches a DeleteEvent to all registered MessageEventListeners.

deleteMessages

public static void deleteMessages(ChannelIdentifier identifier, List<Message> messages, ErrorHandler handler)

Deletes messages for the current user (local + server-side for self) and dispatches a to all registered MessageEventListeners.

disconnect

public static void disconnect()

Disconnects from the server while keeping the push channel alive.

getCancelSendMediaListeners

public static List<Runnable> getCancelSendMediaListeners()

Returns the list of registered cancel-send-media listeners.

getContext

public static Context getContext()

Returns the Application context saved during initialization.

getFragmentFactory

public static ChatUIFragmentFactory getFragmentFactory()

Returns the current ChatUIFragmentFactory.

getMessageEventListeners

public static List<MessageEventListener> getMessageEventListeners()

Returns the list of registered message event listeners.

initialize

public static void initialize(InitParams params)

Initializes the SDK.

insertMessages

public static void insertMessages(ChannelIdentifier identifier, List<InsertMessageItem> items, OperationHandler<Boolean> handler)

Inserts messages and dispatches an InsertEvent to all registered s.

isInitialized

public static boolean isInitialized()

Returns whether the SDK has been initialized.

logout

public static void logout()

Disconnects from the server and closes the push channel.

refreshMessage

public static void refreshMessage(RefreshEvent event)

Dispatches a message refresh event to all registered MessageEventListeners.

removeCancelSendMediaMessageListener

public static void removeCancelSendMediaMessageListener(Runnable listener)

Unregisters a cancel-send-media listener.

removeChannelEventListener

public static void removeChannelEventListener(ChannelEventListener listener)

Unregisters a previously registered channel event listener.

removeMessageEventListener

public static void removeMessageEventListener(MessageEventListener listener)

Unregisters a previously registered message event listener.

saveDraft

public static void saveDraft(ChannelIdentifier channelIdentifier, String draft, OperationHandler<Boolean> handler)

Saves a draft for the given channel and notifies all registered ChannelEventListeners via onSaveDraft on success.

sendMediaMessage

public static void sendMediaMessage(ChannelIdentifier identifier, SendMediaMessageParams params, SendMediaMessageHandler handler)

Sends a media message and dispatches send-lifecycle events to all registered s.

sendMessage

public static void sendMessage(ChannelIdentifier identifier, SendMessageParams params, SendMessageHandler handler)

Sends a text/binary message and dispatches send-lifecycle events to all registered s.

setFragmentFactory

public static void setFragmentFactory(ChatUIFragmentFactory factory)

Replaces the current ChatUIFragmentFactory.

syncConversationReadStatus

public static void syncConversationReadStatus(ChannelIdentifier channelIdentifier, long timestamp, ErrorHandler handler)

Syncs the read status of a channel to the server and notifies all registered s via onClearedUnreadStatus on success.

NCChatUI

See also

Functions