@sendbird/calls-react-native
Preparing search index...
NativeCommonModule
Interface NativeCommonModule
interface
NativeCommonModule
{
applicationId
:
string
;
currentUser
:
User
|
null
;
addDirectCallSound
(
type
:
SoundType
,
fileName
:
string
)
:
void
;
authenticate
(
authParams
:
AuthenticateParams
)
:
Promise
<
User
>
;
createRoom
(
roomParams
:
RoomParams
)
:
Promise
<
RoomProperties
>
;
deauthenticate
()
:
Promise
<
void
>
;
deleteAllCustomItems
(
callId
:
string
)
:
Promise
<
CustomItemUpdateResult
>
;
deleteCustomItems
(
callId
:
string
,
customItemKeys
:
string
[]
,
)
:
Promise
<
CustomItemUpdateResult
>
;
dial
(
calleeUserId
:
string
,
isVideoCall
:
boolean
,
options
:
CallOptions
,
)
:
Promise
<
DirectCallProperties
>
;
fetchRoomById
(
roomId
:
string
)
:
Promise
<
RoomProperties
>
;
getCachedRoomById
(
roomId
:
string
)
:
Promise
<
RoomProperties
|
null
>
;
getCurrentUser
()
:
Promise
<
User
|
null
>
;
getDirectCall
(
callId
:
string
)
:
Promise
<
DirectCallProperties
>
;
getOngoingCalls
()
:
Promise
<
DirectCallProperties
[]
>
;
handleFirebaseMessageData
(
data
:
Record
<
string
,
string
>
)
:
void
;
initialize
(
appId
:
string
)
:
boolean
;
registerPushToken
(
token
:
string
,
unique
?:
boolean
)
:
Promise
<
void
>
;
registerVoIPPushToken
(
token
:
string
,
unique
?:
boolean
)
:
Promise
<
void
>
;
removeDirectCallSound
(
type
:
SoundType
)
:
void
;
routePickerView
()
:
void
;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode
(
enabled
:
boolean
)
:
void
;
setLoggerLevel
(
level
:
"none"
|
"error"
|
"warning"
|
"info"
)
:
void
;
unregisterPushToken
(
token
:
string
)
:
Promise
<
void
>
;
unregisterVoIPPushToken
(
token
:
string
)
:
Promise
<
void
>
;
updateCustomItems
(
callId
:
string
,
customItems
:
Record
<
string
,
string
>
,
)
:
Promise
<
CustomItemUpdateResult
>
;
}
Hierarchy (
View Summary
)
NativeCommonModule
SendbirdCallsNativeSpec
Index
Properties
application
Id
current
User
Methods
add
Direct
Call
Sound
authenticate
create
Room
deauthenticate
delete
All
Custom
Items
delete
Custom
Items
dial
fetch
Room
By
Id
get
Cached
Room
By
Id
get
Current
User
get
Direct
Call
get
Ongoing
Calls
handle
Firebase
Message
Data
initialize
register
Push
Token
register
Vo
IP
Push
Token
remove
Direct
Call
Sound
route
Picker
View
set
Direct
Call
Dialing
Sound
On
When
Silent
Or
Vibrate
Mode
set
Logger
Level
unregister
Push
Token
unregister
Vo
IP
Push
Token
update
Custom
Items
Properties
application
Id
applicationId
:
string
current
User
currentUser
:
User
|
null
Methods
add
Direct
Call
Sound
addDirectCallSound
(
type
:
SoundType
,
fileName
:
string
)
:
void
Parameters
type
:
SoundType
fileName
:
string
Returns
void
authenticate
authenticate
(
authParams
:
AuthenticateParams
)
:
Promise
<
User
>
Parameters
authParams
:
AuthenticateParams
Returns
Promise
<
User
>
create
Room
createRoom
(
roomParams
:
RoomParams
)
:
Promise
<
RoomProperties
>
Parameters
roomParams
:
RoomParams
Returns
Promise
<
RoomProperties
>
deauthenticate
deauthenticate
()
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
All
Custom
Items
deleteAllCustomItems
(
callId
:
string
)
:
Promise
<
CustomItemUpdateResult
>
Parameters
callId
:
string
Returns
Promise
<
CustomItemUpdateResult
>
delete
Custom
Items
deleteCustomItems
(
callId
:
string
,
customItemKeys
:
string
[]
,
)
:
Promise
<
CustomItemUpdateResult
>
Parameters
callId
:
string
customItemKeys
:
string
[]
Returns
Promise
<
CustomItemUpdateResult
>
dial
dial
(
calleeUserId
:
string
,
isVideoCall
:
boolean
,
options
:
CallOptions
,
)
:
Promise
<
DirectCallProperties
>
Parameters
calleeUserId
:
string
isVideoCall
:
boolean
options
:
CallOptions
Returns
Promise
<
DirectCallProperties
>
fetch
Room
By
Id
fetchRoomById
(
roomId
:
string
)
:
Promise
<
RoomProperties
>
Parameters
roomId
:
string
Returns
Promise
<
RoomProperties
>
get
Cached
Room
By
Id
getCachedRoomById
(
roomId
:
string
)
:
Promise
<
RoomProperties
|
null
>
Parameters
roomId
:
string
Returns
Promise
<
RoomProperties
|
null
>
get
Current
User
getCurrentUser
()
:
Promise
<
User
|
null
>
Returns
Promise
<
User
|
null
>
get
Direct
Call
getDirectCall
(
callId
:
string
)
:
Promise
<
DirectCallProperties
>
Parameters
callId
:
string
Returns
Promise
<
DirectCallProperties
>
get
Ongoing
Calls
getOngoingCalls
()
:
Promise
<
DirectCallProperties
[]
>
Returns
Promise
<
DirectCallProperties
[]
>
handle
Firebase
Message
Data
handleFirebaseMessageData
(
data
:
Record
<
string
,
string
>
)
:
void
Parameters
data
:
Record
<
string
,
string
>
Returns
void
Platform
Android *
initialize
initialize
(
appId
:
string
)
:
boolean
Parameters
appId
:
string
Returns
boolean
register
Push
Token
registerPushToken
(
token
:
string
,
unique
?:
boolean
)
:
Promise
<
void
>
Parameters
token
:
string
Optional
unique
:
boolean
Returns
Promise
<
void
>
register
Vo
IP
Push
Token
registerVoIPPushToken
(
token
:
string
,
unique
?:
boolean
)
:
Promise
<
void
>
Parameters
token
:
string
Optional
unique
:
boolean
Returns
Promise
<
void
>
Platform
iOS *
remove
Direct
Call
Sound
removeDirectCallSound
(
type
:
SoundType
)
:
void
Parameters
type
:
SoundType
Returns
void
route
Picker
View
routePickerView
()
:
void
Returns
void
Platform
iOS *
set
Direct
Call
Dialing
Sound
On
When
Silent
Or
Vibrate
Mode
setDirectCallDialingSoundOnWhenSilentOrVibrateMode
(
enabled
:
boolean
)
:
void
Parameters
enabled
:
boolean
Returns
void
set
Logger
Level
setLoggerLevel
(
level
:
"none"
|
"error"
|
"warning"
|
"info"
)
:
void
Parameters
level
:
"none"
|
"error"
|
"warning"
|
"info"
Returns
void
unregister
Push
Token
unregisterPushToken
(
token
:
string
)
:
Promise
<
void
>
Parameters
token
:
string
Returns
Promise
<
void
>
unregister
Vo
IP
Push
Token
unregisterVoIPPushToken
(
token
:
string
)
:
Promise
<
void
>
Parameters
token
:
string
Returns
Promise
<
void
>
Platform
iOS *
update
Custom
Items
updateCustomItems
(
callId
:
string
,
customItems
:
Record
<
string
,
string
>
,
)
:
Promise
<
CustomItemUpdateResult
>
Parameters
callId
:
string
customItems
:
Record
<
string
,
string
>
Returns
Promise
<
CustomItemUpdateResult
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
application
Id
current
User
Methods
add
Direct
Call
Sound
authenticate
create
Room
deauthenticate
delete
All
Custom
Items
delete
Custom
Items
dial
fetch
Room
By
Id
get
Cached
Room
By
Id
get
Current
User
get
Direct
Call
get
Ongoing
Calls
handle
Firebase
Message
Data
initialize
register
Push
Token
register
Vo
IP
Push
Token
remove
Direct
Call
Sound
route
Picker
View
set
Direct
Call
Dialing
Sound
On
When
Silent
Or
Vibrate
Mode
set
Logger
Level
unregister
Push
Token
unregister
Vo
IP
Push
Token
update
Custom
Items
@sendbird/calls-react-native
Loading...
Platform
Android *