Fastboard API

Updated

The API reference guide for the Fastboard SDK.

This page provides the API reference for the Fastboard SDK.

Understand the tech

This section provides the API reference for the Fastboard SDK on Android.

Reference

FastboardView class

getFastboard

public Fastboard getFastboard()

Get the Fastboard object.

The Fastboard SDK does not support initializing a Fastboard instance directly. To get the Fastboard object, you need to add the FastboardView object to the app's layout, and then call the getFastboard method.

Fastboard class

createFastRoom

public FastRoom createFastRoom(FastRoomOptions roomOptions)

preloadWhiteboardView

public static void preloadWhiteboardView() {
    WhiteboardViewManager.get().preload();
}

destroy

public void destroy()

setConfig

public static void setConfig(FastboardConfig config)

FastRoomOptions

public class FastRoomOptions {
     private final String appId;
     private final String uuid;
     private final String token;
     private final String uid;
     private final boolean writable;
     private final FastRegion fastRegion;
}

FastRegion

  • CN_HZ
  • US_SV
  • SG
  • IN_MUM
  • EU

FastUserPayload

public class FastUserPayload {
     private final String nickName;
     private final String avatar;
}

FastboardConfig

public class FastboardConfig {
    private final boolean enablePreload;
    private final int preloadCount;
    private final boolean autoPreload;
}

FastRoom class

join [1/2]

public void join()

join [2/2]

public void join(@Nullable OnRoomReadyCallback onRoomReadyCallback)

setWritable

public void setWritable(boolean writable)

registerApp

public void registerApp(FastRegisterAppParams params, FastResult<Boolean> result)

insertImage

public void insertImage(String url, int width, int height)

insertVideo

public void insertVideo(String url, String title)

insertStaticDoc

public void insertStaticDoc(DocPage[] pages, String title, FastResult<String> result)

insertPptx

public void insertPptx(String taskUuid, String prefixUrl, String title, FastResult<String> result)

insertDocs

public void insertDocs(FastInsertDocParams params, FastResult<String> result)