Skip to main content
Version: Next

Type Alias: UseCallKitResult

UseCallKitResult = object

Defined in: packages/react-native-client/src/hooks/useCallKit.ts:14

Properties​

endCallKitSession()​

endCallKitSession: () => Promise<void>

Defined in: packages/react-native-client/src/hooks/useCallKit.ts:24

Ends the current CallKit session

Returns​

Promise<void>

getCallKitSessionStatus()​

getCallKitSessionStatus: () => Promise<boolean>

Defined in: packages/react-native-client/src/hooks/useCallKit.ts:29

Returns whether there is currently an active CallKit session

Returns​

Promise<boolean>

startCallKitSession()​

startCallKitSession: (config) => Promise<void>

Defined in: packages/react-native-client/src/hooks/useCallKit.ts:19

Starts a CallKit session for the current call

Parameters​

ParameterTypeDescription
configCallKitConfigConfiguration object containing displayName and isVideo

Returns​

Promise<void>