HMSPrebuilt class

HMSPrebuilt is the main widget that is used to render the prebuilt It takes following parameters: roomCode - The room code of the room to join options - The options for the prebuilt for more details check the HMSPrebuiltOptions class

Inheritance

Constructors

HMSPrebuilt({Key? key, required String? roomCode, HMSPrebuiltOptions? options, Function? onLeave, String? authToken})
The key for the widget

Properties

authToken → String?
authToken: The auth token to join the room
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onLeave → Function?
The callback for the leave room button This function can be passed if you wish to perform some specific actions in addition to leaving the room when the leave room button is pressed
final
options → HMSPrebuiltOptions?
The options for the prebuilt For more details checkout the HMSPrebuiltOptions class Defaults to null
final
roomCode → String?
The room code of the room to join This is a required parameter
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Builds the widget Returns a ScreenController widget The ScreenController is the main widget that renders the prebuilt For more details checkout the ScreenController class It takes the roomCode,authToken, options and onLeave as parameters The roomCode is the room code of the room to join The authToken is the auth token to join the room User need to pass either roomCode or authToken to join the room The options are the options for the prebuilt For more details checkout the HMSPrebuiltOptions class The options are optional and are used to customize the prebuilt The onLeave is the callback for the leave room button
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited