Netless

Netless

  • JavaScript
  • Android
  • iOS
  • Server
  • FAQ
  • GitHub
  • 🇨🇳 中文

›Features

Document structure

  • Outline

Installation guide

  • SDK install
  • Version history
  • Open source
  • Debug

Quick start

  • Precondition
  • Room authentication
  • Real-time room
  • replay

Initialization

  • SDK parameters
  • Room parameters
  • Replay parameters

Features

  • Tools
  • Perspective operation
  • Page (scene) management
  • Status listen
  • Whiteboard operation
  • Custom event
  • Cursor position sync
  • Document conversion
  • Replay
  • Big class read-only
  • Plugins

Upgrade

  • SDK v2 migration

Big class read-only

1. Why enable read-only

Increase the maximum number of people that can be carried in a room and reduce the cost of subscribing to a long connection. (sdk upgrade to latest support)

Detailed description of read-only mode and interactive mode

2. How to enable read-only

2.1 Enable read-only before joining (recommended)

     const room = await whiteWebSdk.joinRoom({
                    uuid: uuid,
                    roomToken: roomToken,
                    isWritable: false, // Write {isWritable: false} in the parameter of jionRoom method, good performance
                    ...
                    },

2.2 Open (or close) read-only after joining

     const room = await whiteWebSdk.joinRoom({
                    uuid: uuid,
                    roomToken: roomToken,
                    ...
                    },
    room.setWritable(false); // Write {isWritable: false} in the parameter of jionRoom method, flexible

3. Notes

When read-only is turned on, all member methods and member properties under the room object that need to interact with the server will lose their effect. If they are called in read-only mode, an error will be reported. In order to facilitate customer integration and reduce interference by error, we provide a unique error level adjustment API in read-only mode.

  const room = await whiteWebSdk.joinRoom({
                    uuid: uuid,
                    roomToken: roomToken,
                    rejectWhenReadonlyErrorLevel: RoomErrorLevel.Ignore, // js just use the string "ignore"
                    ...
                    },
Last updated on 2/24/2020 by 伍双
← ReplayPlugins →
  • 1. Why enable read-only
  • 2. How to enable read-only
    • 2.1 Enable read-only before joining (recommended)
    • 2.2 Open (or close) read-only after joining
  • 3. Notes
Netless
Let's interactive.
Product
ConsoleHomepageDemoGithub
Company
Join usServicePrivacy
Contact
support@netless.linkCommunity
Copyright © 2020 Netless