@samanthashepherddubit/rncometchat v1.1.0

Comet Chat Wrapper for React Native

Wrapper for comet chat SDK to handle all the logic for sending and receiving messages. It also provides a Flatlist container that will render them.

Installation

If using yarn:

yarn add @samanthashepherddubit/rncometchat

If using npm:

npm i @samanthashepherddubit/rncometchat

Usage

First you need to initalise and login to comet chat using this helper function.

import { loginCometChat } from '@samanthashepherddubit/rncometchat';

Example of useage:

  React.useEffect(() => {
    /**
     * Login to chat
     */
    loginCometChat(chatUid, apiKey, appId, region);
  }, []);

Sending a text message

import { sendTextMessage } from '@samanthashepherddubit/rncometchat';

Example of useage:

const message = "Text message to show"

sendTextMessage(chatID, message, receiverType, metaData);

Sending a picture message

import { sendMediaMessage } from '@samanthashepherddubit/rncometchat';

Example of useage:

const file = {
  name: "Camera_001.jpeg",
  type: "image/jpeg",
  uri: "file:///Users/flower.jpg"
}

sendMediaMessage(chatID, file, receiverType, metaData);

Sending a custom message

import { sendCustomMessage } from '@samanthashepherddubit/rncometchat';

Example of useage:

const customType = CustomMessageTypes.POLL;
const customData = { question: "Question", answers: ["Answer 1", "Answer 2"] };

sendCustomMessage(chatId, receiverType, customType, customData, metadata);

Fetching messages

import { fetchMessages } from '@samanthashepherddubit/rncometchat';

Example of useage:

const messages = await fetchMessages(chatId, receiverType, numberOfMessages);

Clearing messages

import { clearMessages } from '@samanthashepherddubit/rncometchat';

Deleting own message

import { deleteOwnMessage } from '@samanthashepherddubit/rncometchat';

Example of useage:

deleteOwnMessage(messageId);

Displaying the messages

import { Chat } from '@samanthashepherddubit/rncometchat';

Example of useage:

<Chat
  renderTextMessage={(message: CometChat.TextMessage) => (
    <ChatTextMessage message={message} />
  )}
  renderImageMessage={(message: CometChat.MediaMessage) => (
    <ChatImageMessage message={message} />
  )}
  renderPollMessage={(message: CometChat.CustomMessage) => (
    <ChatImageMessage message={message} />
  )}
  renderErrorMessage={(error: string) => (
    <ChatImageMessage message={message} />
  )}
  messageConfig={[MessageConfig.TEXT, MessageConfig.FILE]}
  chatID={groupID}
  receiverType={RECEIVER_TYPE}
  messageFetchSize={30}
/>

MessageConfig

import { MessageConfig } from '@samanthashepherddubit/rncometchat';

List of message types that will be added to the message listeners | Key | Description |-------------|------------------- | TEXT | For text messages | FILE | For image messages | CUSTOM | For custom messages

CustomMessageTypes

import { CustomMessageTypes } from '@samanthashepherddubit/rncometchat';

List of message types to use in custom messages to do certain behaviour