README.md

Chat Plugin for Skygear

Related SDK

You can find the SDK code in following repos on github. You can also directly install at the package manager.

• JS - chat-SDK-JS on npm

  Source: https://github.com/SkygearIO/chat-SDK-JS

• iOS - SKYKitChat on cocoapods

  Source: https://github.com/SkygearIO/chat-SDK-iOS

• Android - [chat-SDK-Android] io.skygear.chat on jscentre

  Source: https://github.com/SkygearIO/chat-SDK-Android

Get the demo running at Skygear cloud

First

Assumed you go registered at https://portal.skygeario.com

Second

git submodule to import the source code.

git submodule add https://github.com/SkygearIO/chat.git chat

In your cloud code, import the chat plugin. Skygear will load and lambda and database hook will be ready for use.

from skygear.settings import settings

from .chat import includeme

includeme(settings)

Third

Tell Skygear cloud to serve the asset from chat-SDK-JS demo folder

git submodule to import the JS SDK source code.

git submodule add https://github.com/SkygearIO/chat-SDK-JS.git chat-SDK-JS

from skygear import static_assets
from skygear.utils.assets import relative_assets

@static_assets(prefix='demo')
def chat_demo():
    return relative_assets('chat-SDK-JS/demo')

https://<your_app_name>.skygeario.com/static/demo/index.html

Quick Start

We provide Quick Start tutorial in different language.

• Javascript
• Android
• iOS

We also have basic guide go through feature by feature.

• Javascript
• Android
• iOS

Understanding the model

In this chat plugin, we have various model represent different data in application. Understanding the model relation make you able to use the plugin efficiently. It also enable developer to store application specific data in the correct model.

Following is the model relation diagram.

Overview of models responsibility are as follow.

• Conversation - represent a conversation, it store conversation information like title, last message, no. of participant.
• Message - actual message display on screen, it store message text, related asset and metadata.
• UserConversation - represent a user is participating a conversation. It stores user specific information to a conversation, like last read time and unread count.
• Receipt - Store the user receipt on a message.

Details attributes on models

Following is the table of attributes ensured by this plugin.

Note that User is Skygear provided User profile model.

User

Attributes	Type	Description
name	String

Conversation

Attributes	Type	Description
title	String
admin_ids	JSON Array
participant_ids	JSON Array
participant_count	Number
distinct_by_participants	Boolean
metadata	JSON Object
last_message	Reference

Message

Attributes	Type	Description
body	String
conversation_status	String	Summary of receipt status
attachment	Asset
metadata	JSON Object
conversation_id	Reference

UserConversation

Attributes	Type	Description
unread_count	Number
last_read_message	Reference
user	Reference
conversation	Reference

Receipt

Attributes	Type	Description
read_at	Datetime
delivered_at	Datetime
user_id	Reference
message_id	Reference

Detail API

For API detail, please visit the platform specific API filie:

• JS SDK
• iOS SDK
• Android SDK
• Skygear.io

Some sample code

Sending push notification

Push notification can be implemented by the following code. Please ensure APNS certificate and private key are properly setup, if you are using [Skygear.io], you can configure it at the setting panel.

import skygear
from skygear.container import SkygearContainer
from skygear.options import options as skyoptions
from skygear.action import push_user

# Import the chat plugin module.
# If you not using pip for the plugin, you will have modify the following lines
# to use relative import.
# For example if you have the `chat` folder located at the root of the project,
# you should use `from .chat import ...` instead of `from chat import ...`
from chat.user_conversation import total_unread
from chat.conversation import Conversation
from chat.message import Message

# Create a container so we can talk to skygear server
container = SkygearContainer(api_key=skyoptions.masterkey)

# Register a handler after message is saved
@skygear.after_save("message")
def push_message_after_save_handler(record, original_record, conn):
    message = Message.from_record(record)
    conversation = Conversation(message.fetchConversationRecord())

    # Fetch the owner of the message
    resp = container.send_action('record:query', {
            'record_type': 'user',
            'predicate': [
                'eq',
                {'$type': 'keypath', '$val': '_id'},
                record._owner_id
            ]
        })
    user_record = resp['result'][0]

    # Construct the message for push notification
    if conversation['title'] is None:
        push_message = '{0}: {1}'.format(user_record['name'], record['body'])
    else:
        push_message = '{0}@{1}: {2}'.format(user_record['name'], conversation['title'], record['body'])

    # Send push notification to each participant
    for participant_id in conversation.participant_set:
        # Except the message author
        if record._owner_id == participant_id:
            continue

        # Get the total unread message count
        total_unread_count = total_unread(participant_id)['message']

        # Finally send the notification
        push_user(
            container,
            participant_id,
            {
                'apns': {
                    'aps': {
                        'alert': push_message,
                        'sound': 'default',
                        'badge': total_unread_count,
                    },
                    'from': 'skygear-chat',
                    'operation': 'notification'
                },
            }
        )

Support

For implementation related questions or technical support, please find us on the official forum or community chat; For bug reports or feature requests, feel free to open an issue in this repo