Skip to main content
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.
Facilitates direct interaction with the Matrix API to manage media, user profiles, and room properties.

Features

  • Media Management: Upload files to the Matrix server
  • User Profile Handling: Retrieve and modify user profile data
  • Room Operations: Manage room visibility and memberships
Provides automation capabilities for managing rooms and simplifying workflows.

Features

  • Entity Room Management: Automatically create entity-specific rooms
  • Room Automation: Use bots to manage room invitations and memberships
Handles room states and access control lists (ACLs) for secure room management.

Features

  • Access Control Management: Configure ACLs for rooms
  • State Management: Fetch and adjust room states
Provides helper functions for working within the Matrix ecosystem.

Features

  • MXC Utilities: Convert Matrix Content URLs
  • Validators: Validate room IDs, user IDs, and aliases

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.
I