ZegoUIKitPrebuiltCall class APIs Events Configs Components Migration_v4.x
Call Widget. You can embed this widget into any page of your project to integrate the functionality of a call. You can refer to our documentation, or our sample code.
If you need the function of call invitation, please use ZegoUIKitPrebuiltCallInvitationService together.
And refer to the sample code.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ZegoUIKitPrebuiltCall
Constructors
-
ZegoUIKitPrebuiltCall({Key? key, required int appID, required String callID, required String userID, required String userName, required ZegoUIKitPrebuiltCallConfig config, String appSign = '', String token = '', ZegoUIKitPrebuiltCallEvents? events, VoidCallback? onDispose, List<
IZegoUIKitPlugin> ? plugins}) -
const
Properties
- appID → int
-
You can create a project and obtain an appID from the ZEGOCLOUD Admin Console.
final
- appSign → String
-
log in by using appID + appSign.
final
- callID → String
-
The ID of the call.
This ID is a unique identifier for the current call, so you need to ensure its uniqueness.
It can be any valid string.
Users who provide the same callID will be logged into the same room for the call.
final
- config → ZegoUIKitPrebuiltCallConfig
-
Initialize the configuration for the call.
final
- events → ZegoUIKitPrebuiltCallEvents?
-
Initialize the events for the call.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onDispose → VoidCallback?
-
Callback when the page is destroyed.
final
-
plugins
→ List<
IZegoUIKitPlugin> ? -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- token → String
-
log in by using appID + token.
final
- userID → String
-
The ID of the currently logged-in user.
It can be any valid string.
Typically, you would use the ID from your own user system, such as Firebase.
final
- userName → String
-
The name of the currently logged-in user.
It can be any valid string.
Typically, you would use the name from your own user system, such as Firebase.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ZegoUIKitPrebuiltCall> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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