fornever / smith.matrixsdk

Matrix SDK for .NET.

Smith.MatrixSdk

SDK for Matrix network API.

Documentation

• Changelog
• Maintainership
• License (MIT)

Quick start

Please see Smith.MatrixSdk.Example.Simplified project for a working example.

Features

This library implements the following features from the Matrix Client-Server API r0.6.1:

• 2 API Standards
  • Error response recognition
  • 2.1 GET /_matrix/client/versions
• 3 Web Browser Clients: not applicable
• 4 Server Discovery
• 5 Client Authentication
  • Device support
  • 5.3 Soft logout
  • 5.4 User-Interactive Authentication API
    • 5.4.2 User-interactive API in the REST API
    • 5.4.4 Authentication types
      • 5.4.4.1 Password-based
        • Basic (deprecated) support
        • identifier field
      • 5.4.4.2 Google ReCaptcha
      • 5.4.4.3 Token-based
      • 5.4.4.4 OAuth2-based
      • 5.4.4.5 Single Sign-On
      • 5.4.4.6 Email-based (identity / homeserver)
      • 5.4.4.7 Phone number/MSISDN-based (identity / homeserver)
      • 5.4.4.8 Dummy Auth authentication
    • 5.4.5 Fallback
    • 5.4.6 Identifier types
  • 5.5 Login
    • 5.5.1 GET /_matrix/client/r0/login
    • 5.5.2 POST /_matrix/client/r0/login
      • Basic (deprecated) version (user field)
      • Request fields: identifier, token, device_id, initial_device_display_name
      • Response fields: device_id, well_known
        • Remove refresh_token support
    • 5.5.3 POST /_matrix/client/r0/logout
    • 5.5.4 POST /_matrix/client/r0/logout/all
    • 5.5.5 Login Fallback
  • 5.6 Account registration and management
  • 5.7 Adding Account Administrative Contact Information
  • 5.8 Current account information
• 6 Capabilities negotiation
• 7 Pagination
• 8 Filtering
• 9 Events
  • 9.3 Room Events
  • 9.4 Syncing
    • 9.4.1 GET /_matrix/client/r0/sync
      • Basic features
      • Send-to-Device messaging features
      • End-to-end encryption features
  • 9.5 Getting events for a room
  • 9.6 Sending events to a room
  • 9.7 Redactions
• 10 Rooms
• 11 User Data
• 12 Security
• 13 Modules

Build

To build Smith.MatrixSdk, you'll need .NET Core SDK 5.0 or later.

$ dotnet build --configuration Release

(replace Release with Debug for debug build)

smith.matrixsdk's Issues

Support alternate autnehtication types

Currently, Smith.MatrixSdk only supports the password flow. We should support all the officially defined types, though (or at least the ones that's possible to support).

Client should require HttpClientFactory instead of HttpClient

This way, we'll be able to switch between homeservers in runtime, and also won't mutate the passed HttpClient instance.