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

Reference

Fastboard class

createFastRoom

public class func createFastRoom(withFastRoomConfig config: FastRoomConfiguration)

Create a FastRoom instance.

FastRoomConfiguration

public init(appIdentifier: String,
                 roomUUID: String,
                 roomToken: String,
                 region: Region,
                 userUID: String,
                 userPayload: FastUserPayload? = nil)

Region

  • CN
  • US
  • SG
  • IN
  • EU

FastUserPayload

public class FastUserPayload: NSObject {
    let nickName: String?
    let avatar: String?
}

FastRoom class

joinRoom

public func joinRoom(completionHandler: ((Result<WhiteRoom, FastRoomError>)->Void)? = nil)

disconnectRoom

public func disconnectRoom()

insertImg

public func insertImg(_ src: URL, imageSize: CGSize)

insertMedia

public func insertMedia(_ src: URL, title: String, completionHandler: ((String)->Void)? = nil)

insertPptx

public func insertPptx(
     uuid: String,
     url: String,
     title: String,
     completionHandler: ((String)->Void)? = nil
 )

insertStaticDocument

public func insertStaticDocument(_ pages: [WhitePptPage],
                                      title: String,
                                      completionHandler: ((String)->Void)? = nil)

followSystemPencilBehavior

public static var followSystemPencilBehavior

FastRoomThemeManager class

apply

public func apply(_ theme: FastRoomThemeAsset)