nahtuh-client v1.0.12

Nahtuh Client

Nahtuh client is a javascript library to use nahtuh API to develop real time collaboration application.

Contents

• Getting Started
• API Documentation
  • Connection Api
    • Start Connection
    • Stop Connection
  • Event Management Api
    • Create Event
    • Join Event
    • Leave Event
    • Get Participant List
    • Get Current Participant
  • Group Management Api
    • Join Group
    • Leave Group
    • Get Group Member
  • Host Configuration API
    • Set Host Configuration
    • Get Host Configuration
  • Messaging Api
    • Broadcast
    • Send To User
    • Send To Group
  • Event Handlers
    • On Participant Joined
    • On Participant Leave
    • On Incoming Message
    • On Group Member Joined

    • On Group Member Left

Getting Started

CDN

<!-- index.html -->
<script src="https://cdn.nahtuh.com/libraries/nahtuhclient.js"></script>
<script>
  const { nahtuhClient, identityManager } = window.NahtuhClient;
</script>

NPM

npm i nahtuh-client

import { nahtuhClient, identityManager } from 'nahtuh-client';

API Documentation

Connection API

Start Connection

Start websocket connection

// use this only when autoStart is set to false
let response = await nahtuhClient.start();

Stop Connection

Stop websocket connection

// use this only when autoStart is set to false
let response = await nahtuhClient.stop();

Event Management API

Create Event

let response = await nahtuhClient.createEvent(participantName, autoStart);

Parameters

Response

Join Event

let response = await nahtuhClient.join(eventId, participantName, autoStart);

Parameters

Response

Leave Event

let response = await nahtuhClient.leaveEvent(autoStop);

Parameters

Get Participant List

Get all participants in the current event

let response = await nahtuhClient.getParticipantList();

Response

Get Current Participant

Get current participant info

let response = await nahtuhClient.getCurrentParticipant();

Response

Group Management API

Join Group

Create or join existing group

let response = await nahtuhClient.joinGroup(participantId, groupName);

Parameters

Leave Group

let response = await nahtuhClient.leaveGroup(participantId, groupName);

Parameters

Get Group Member

Get all group members

let response = await nahtuhClient.getGroupMember(groupName);

Parameters

Response

Host Configuration API

Host configuration is a configuration only the event's host can access. It can be useful to implement host rejoin functionality.

Set Host Configuration

await nahtuhClient.setHostConfiguration(config);

Parameters

Get Host Configuration

var response = await nahtuhClient.getHostConfiguration();

Response

Messaging API

Broadcast

Send message to all event participants

let response = await nahtuhClient.broadcast(message);

Parameters

Send To User

Send message to a specific user

let response = await nahtuhClient.sendToUser(participantId, message);

Parameters

Send To Group

Send message to all participant in a specific group

let response = await nahtuhClient.sendToGroup(groupName, message);

Parameters

Event Handlers

On Participant Joined

Call back function when new participant join to an event

nahtuhClient.onParticipantJoined = (data) => {}

Data

On Participant Leave

call back function when new participant leave an event

nahtuhClient.onParticipantLeave = (data) => {}

Data

On Incoming Message

call back function when new message received

nahtuhClient.onIncomingMessage = (data) => {}

Data

On Group Member Joined

call back function when participant join to a group

nahtuhClient.onGroupMemberJoined = (data) => {}

Data

On Group Member Left

call back function when participant left a group

nahtuhClient.onGroupMemberLeft = (data) => {}

Data

Types

EventInfo

Participant

ParticipantToken

GroupMember

Message