The IXO Matrix Client SDK is a comprehensive toolkit that enables developers to interact seamlessly with a Matrix server and associated bot services. This SDK helps in managing user profiles, room details, and room states, leveraging both pre-configured and custom Matrix home servers.

​
Installation

The IXO Matrix Client SDK can be installed via npm or yarn:

npm install @ixo/matrixclient-sdk
# or
yarn add @ixo/matrixclient-sdk

​
Quick Start

Import the required components into your project:

import {
  createMatrixApiClient,
  createMatrixRoomBotClient,
  createMatrixStateBotClient,
  utils
} from '@ixo/matrixclient-sdk';

​
Use Cases

The IXO Matrix Client SDK is highly versatile and can be used in multiple scenarios:

  • Real-Time Communication: Manage real-time user communication using Matrix rooms
  • Automated Room Management: Leverage bot clients to automate room management
  • Access Control: Use ACLs and state management tools to control room access

This GitHub repository is private. Request access by contacting the IXO World team.

NPM Package

View on NPM

GitHub Repository

View the source code

Getting Started

Start building with our developer guides

Was this page helpful?