ConnectycubeFlutterCallKit class
Plugin to manage call events and notifications
Constructors
- ConnectycubeFlutterCallKit()
-
Plugin to manage call events and notifications
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
init(
{CallEventHandler? onCallAccepted, CallEventHandler? onCallRejected, CallEventHandler? onCallIncoming, String? ringtone, String? icon, String? notificationIcon, String? color}) → void - Initialize the plugin and provided user callbacks.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateConfig(
{String? ringtone, String? icon, String? notificationIcon, String? color}) → Future< void> -
Sets the additional configs for the Call notification
ringtone- the name of the ringtone source (for Anfroid it should be placed by path 'res/raw', for iOS it is a name of ringtone)icon- the name of image in thedrawablefolder for Android and the name of Assests set for iOSnotificationIcon- the name of the image in thedrawablefolder, uses as Notification Small Icon for Android, ignored for iOScolor- the color in the format '#RRGGBB', uses as an Android Notification accent color, ignored for iOS
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → ConnectycubeFlutterCallKit
-
no setter
- onCallAcceptedWhenTerminated ← CallEventHandler?
-
Set a accept call handler function which is called when the app is in the
background or terminated.
no getter
- onCallIncomingWhenTerminated ← CallEventHandler?
-
Set an incoming call handler function which is called when the app is in the
background or terminated.
no getter
- onCallMuted ↔ (dynamic Function(bool isMuted, String sessionId)?)
-
iOS only callbacks
getter/setter pair
- onCallRejectedWhenTerminated ← CallEventHandler?
-
Set a reject call handler function which is called when the app is in the
background or terminated.
no getter
- onTokenRefreshed ↔ (dynamic Function(String newToken)?)
-
getter/setter pair
- TAG ↔ String
-
getter/setter pair
Static Methods
-
canUseFullScreenIntent(
) → Future< bool> - Returns whether the app can send fullscreen intents (required for showing the Incoming call screen on the Lockscreen)
-
clearCallData(
{required String? sessionId}) → Future< void> - Cleans all data related to the call
-
getCallData(
{required String? sessionId}) → Future< Map< String, dynamic> ?> - Retrieves call information about the call
-
getCallState(
{required String? sessionId}) → Future< String> - Get the current call state
-
getLastCallId(
) → Future< String?> - Returns the id of the last displayed call. It is useful on starting app step for navigation to the call screen if the call was accepted
-
getToken(
) → Future< String?> - Returns VoIP token for iOS plaform. Returns FCM token for Android platform
-
initEventsHandler(
) → void -
provideFullScreenIntentAccess(
) → Future< void> - Opens the Setting to grant/deny permission for running the fullscreen Intents
-
reportCallAccepted(
{required String? sessionId}) → Future< void> - Report that the current active call has been accepted by your application
-
reportCallEnded(
{required String? sessionId}) → Future< void> - Report that the current active call has been ended by your application
-
reportCallMuted(
{required String? sessionId, required bool? muted}) → Future< void> - Report that the current active call has been ended by your application
-
setCallState(
{required String? sessionId, required String? callState}) → Future< void> - Updates the current call state
-
setOnLockScreenVisibility(
{required bool? isVisible}) → Future< void> -
showCallNotification(
CallEvent callEvent) → Future< void> - Show incoming call notification