Ends the call.
DirectCallListener.onEnded will be called after successful ending.
This listener will also be called when the remote user ends the call.
since
1.0.0
-
Returns Promise<void>
muteMicrophone
muteMicrophone(): void
+
Returns Promise<void>
muteMicrophone
muteMicrophone(): void
Mutes the audio of local user.
Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user.
If the remote user changes their audio settings, local user will be notified via same delegate method.
Toggles the selection between the front and the back camera.
on Android, In case of more than two cameras, the next camera will be selected.
If the last camera is already selected, the first one will be selected again.
since
1.0.0
-
Returns Promise<void>
unmuteMicrophone
unmuteMicrophone(): void
+
Returns Promise<void>
unmuteMicrophone
unmuteMicrophone(): void
Unmutes the audio of local user.
Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user.
If the remote user changes their audio settings, local user will be notified via same delegate method.
\ No newline at end of file
diff --git a/docs/classes/DirectCallVideoView.html b/docs/classes/DirectCallVideoView.html
index eef59f5..339b448 100644
--- a/docs/classes/DirectCallVideoView.html
+++ b/docs/classes/DirectCallVideoView.html
@@ -13,7 +13,7 @@
typeMyContext = number constCtx = React.createContext<MyContext>(0)
Called to determine whether the change in props and state should trigger a re-render.
Component always returns true.
PureComponent implements a shallow comparison on props and state and returns true if any
diff --git a/docs/classes/GroupCallVideoView.html b/docs/classes/GroupCallVideoView.html
index 0219d3a..f66bad7 100644
--- a/docs/classes/GroupCallVideoView.html
+++ b/docs/classes/GroupCallVideoView.html
@@ -13,7 +13,7 @@
typeMyContext = number constCtx = React.createContext<MyContext>(0)
Called to determine whether the change in props and state should trigger a re-render.
Component always returns true.
PureComponent implements a shallow comparison on props and state and returns true if any
diff --git a/docs/classes/LocalParticipant.html b/docs/classes/LocalParticipant.html
index 92eef86..b0f33f4 100644
--- a/docs/classes/LocalParticipant.html
+++ b/docs/classes/LocalParticipant.html
@@ -1,24 +1,24 @@
-
Mutes the audio of the local user.
Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants.
If the remote user changes their audio settings, the local user will be notified via the same method.
since
1.0.0
-
Returns void
startVideo
startVideo(): void
+
Returns void
startVideo
startVideo(): void
Unmutes the audio of the local user.
Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants.
If the remote user changes their video settings, the local user will be notified via the same method.
since
1.0.0
-
Returns void
stopVideo
stopVideo(): void
+
Returns void
stopVideo
stopVideo(): void
Unmutes the audio of the local user.
Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants.
If the remote user changes their video settings, the local user will be notified via the same method.
since
1.0.0
-
Returns void
switchCamera
switchCamera(): Promise<void>
+
Returns void
switchCamera
switchCamera(): Promise<void>
Toggles the selection between the front and the back camera.
on Android, In case of more than two cameras, the next camera will be selected.
If the last camera is already selected, the first one will be selected again.
since
1.0.0
-
Returns Promise<void>
unmuteMicrophone
unmuteMicrophone(): void
+
Returns Promise<void>
unmuteMicrophone
unmuteMicrophone(): void
Unmutes the audio of the local user.
Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants.
If the remote user changes their audio settings, the local user will be notified via the same method.
\ No newline at end of file
diff --git a/docs/classes/Room.html b/docs/classes/Room.html
index 3e8d8c8..67ef89f 100644
--- a/docs/classes/Room.html
+++ b/docs/classes/Room.html
@@ -1,41 +1,41 @@
-Room | @sendbird/calls-react-native
Selects audio device
Changes current audio device asynchronously.
Will trigger RoomListener.onAudioDeviceChanged method of the local participant after successfully changing the audio device.
Enter the room
Will trigger RoomListener.onRemoteParticipantEntered method of remote participants after successfully entering the room.
If a remote participant entered the room, the local user will be notified via the same method.
Exit from the room
Will trigger RoomListener.onRemoteParticipantExited method of remote participants after successfully exiting the room.
If a remote participant exited the room, the local user will be notified via the same method.
\ No newline at end of file
diff --git a/docs/classes/SendbirdCallsModule.html b/docs/classes/SendbirdCallsModule.html
index 23d909c..9613b70 100644
--- a/docs/classes/SendbirdCallsModule.html
+++ b/docs/classes/SendbirdCallsModule.html
@@ -1,116 +1,116 @@
SendbirdCallsModule | @sendbird/calls-react-native
To receive native-like calls while an app is in the background or closed, a device registration token must be registered to the server.
Register a device push token after authentication has completed using the SendbirdCalls.ios_registerVoIPPushToken() method.
platform
iOS
since
1.0.0
-
Parameters
token: string
unique: boolean = true
Returns Promise<void>
ios_routePickerView
ios_routePickerView(): void
+
Parameters
token: string
unique: boolean = true
Returns Promise<void>
ios_routePickerView
ios_routePickerView(): void
Show-up a view that allows user to change the system audio route.
AVRoutePickerView in iOS 11 or later
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass DirectCall
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
binder: default
props: DirectCallProperties
Returns DirectCall
Accessors
android_
Gets available audio devices.
-Returns AudioDeviceType[]
android_
Returns AudioDeviceType[]
android_
Gets current audio device.
-Returns null | AudioDeviceType
available
Returns null | AudioDeviceType
available
Gets available video devices. List of available VideoDevice.
-Returns VideoDevice[]
call
Returns VideoDevice[]
call
Gets call ID.
-Returns string
call
Returns string
call
Gets call log.
-Returns null | DirectCallLog
callee
Returns null | DirectCallLog
callee
Gets callee.
-Returns null | DirectCallUser
caller
Returns null | DirectCallUser
caller
Gets caller.
-Returns null | DirectCallUser
current
Returns null | DirectCallUser
current
Gets current video device.
-Returns null | VideoDevice
custom
Returns null | VideoDevice
custom
Gets custom items of this DirectCall instance.
-Returns Record<string, string>
duration
Returns Record<string, string>
duration
Gets call duration(ms).
-Returns number
end
Returns number
end
Gets end result.
-Returns DirectCallEndResult
ended
Returns DirectCallEndResult
ended
Gets ender.
-Returns null | DirectCallUser
ios_
Returns null | DirectCallUser
ios_
The UUID form of callId. Useful when dealing with CallKit.
-Returns null | string
is
Returns null | string
is
Is ended. True if call is ended. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is local audio enabled. True if local audio is enabled. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Indicates whether the local user's screen is being shared. True if the local user's screen is being shared. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is local video enabled. True if local video is enabled. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Indicates whether the call is on hold by either a callee or a caller, or by both. True if the DirectCall is on hold. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is ongoing. True if call is ongoing. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is remote audio enabled. True if remote audio is enabled. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is remote video enabled. True if remote video is enabled. Otherwise, false.
-Returns boolean
is
Returns boolean
is
Is video call.
-Returns boolean
local
Returns boolean
local
Gets local recording status.
-Returns RecordingStatus
local
Returns RecordingStatus
local
Gets local user.
-Returns null | DirectCallUser
my
Returns null | DirectCallUser
my
Gets my role.
-Returns null | DirectCallUserRole
remote
Returns null | DirectCallUserRole
remote
Gets remote recording status.
-Returns RecordingStatus
remote
Returns RecordingStatus
remote
Gets remote user.
-Returns null | DirectCallUser
started
Returns null | DirectCallUser
started
Gets call startedAt timestamp.
-Returns number
Methods
accept
Returns number
Methods
accept
Accepts call.
1.0.0
-Parameters
options: CallOptions = ...
holdActiveCall: boolean = false
Returns Promise<void>
add
Parameters
options: CallOptions = ...
holdActiveCall: boolean = false
Returns Promise<void>
add
Add DirectCall listener. supports multiple listeners.
1.0.0
-Parameters
listener: Partial<DirectCallListener>
Returns (() => void)
Returns void
android_
Parameters
listener: Partial<DirectCallListener>
Returns (() => void)
Returns void
android_
Selects audio device.
Android
1.0.0
-Parameters
device: AudioDeviceType
Returns Promise<void>
end
Parameters
device: AudioDeviceType
Returns Promise<void>
end
Ends the call. DirectCallListener.onEnded will be called after successful ending. This listener will also be called when the remote user ends the call.
1.0.0
-Returns Promise<void>
mute
Returns Promise<void>
mute
Mutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.
1.0.0
-Returns void
select
Returns void
select
Selects video device. Changes current video device asynchronously.
1.0.0
-Parameters
device: VideoDevice
Returns Promise<void>
start
Parameters
device: VideoDevice
Returns Promise<void>
start
Starts local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.
1.0.0
-Returns void
stop
Returns void
stop
Stops local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.
1.0.0
-Returns void
switch
Returns void
switch
Toggles the selection between the front and the back camera.
on Android, In case of more than two cameras, the next camera will be selected. If the last camera is already selected, the first one will be selected again.
1.0.0
-Returns Promise<void>
unmute
Returns Promise<void>
unmute
Unmutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.
1.0.0
-Returns void
update
Returns void
update
Update local video view.
DirectCallVideoView.videoViewId
1.0.0
-Parameters
videoViewId: number
Returns void
update
Parameters
videoViewId: number
Returns void
update
Update remote video view.
DirectCallVideoView.videoViewId
1.0.0
diff --git a/docs/classes/DirectCallLogListQuery.html b/docs/classes/DirectCallLogListQuery.html index b06a046..00b074d 100644 --- a/docs/classes/DirectCallLogListQuery.html +++ b/docs/classes/DirectCallLogListQuery.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass DirectCallLogListQuery
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
queryKey: `native#${string}`
type: DIRECT_CALL_LOG
binder: default
Returns DirectCallLogListQuery
Accessors
has
Returns boolean
is
Returns boolean
Methods
next
Returns Promise<DirectCallLog[]>
release
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass DirectCallLogListQuery
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
queryKey: `native#${string}`
type: DIRECT_CALL_LOG
binder: default
Returns DirectCallLogListQuery
Accessors
has
Returns boolean
is
Returns boolean
Methods
next
Returns Promise<DirectCallLog[]>
release
Returns void
Generated using TypeDoc
https://react.dev/reference/react/Component#static-contexttype
-Accessors
video
Returns number
Methods
Optional UNSAFE_
Accessors
video
Returns number
Methods
Optional UNSAFE_
Called immediately before mounting occurs, and before
Component#render. Avoid introducing any side-effects or subscriptions in this method.This method will not stop working in React 17.
@@ -85,7 +85,7 @@ things such as scroll position beforerendercauses changes to it.Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
-Parameters
prevProps: Readonly<DirectCallVideoViewProps>
prevState: Readonly<{}>
Returns any
render
Returns Element
set
Type Parameters
K extends never
Parameters
state: null | {} | ((prevState: Readonly<{}>, props: Readonly<DirectCallVideoViewProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>
Optional callback: (() => void)
Returns void
Returns void
Optional should
Parameters
prevProps: Readonly<DirectCallVideoViewProps>
prevState: Readonly<{}>
Returns any
render
Returns Element
set
Type Parameters
K extends never
Parameters
state: null | {} | ((prevState: Readonly<{}>, props: Readonly<DirectCallVideoViewProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>
Optional callback: (() => void)
Returns void
Returns void
Optional should
Called to determine whether the change in props and state should trigger a re-render.
Componentalways returns true.PureComponentimplements a shallow comparison on props and state and returns true if any diff --git a/docs/classes/GroupCallVideoView.html b/docs/classes/GroupCallVideoView.html index 0219d3a..f66bad7 100644 --- a/docs/classes/GroupCallVideoView.html +++ b/docs/classes/GroupCallVideoView.html @@ -13,7 +13,7 @@https://react.dev/reference/react/Component#static-contexttype
-Accessors
video
Returns number
Methods
Optional UNSAFE_
Accessors
video
Returns number
Methods
Optional UNSAFE_
Called immediately before mounting occurs, and before
Component#render. Avoid introducing any side-effects or subscriptions in this method.This method will not stop working in React 17.
@@ -85,7 +85,7 @@ things such as scroll position beforerendercauses changes to it.Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
-Parameters
prevProps: Readonly<GroupCallVideoViewProps>
prevState: Readonly<{}>
Returns any
render
Returns Element
set
Type Parameters
K extends never
Parameters
state: null | {} | ((prevState: Readonly<{}>, props: Readonly<GroupCallVideoViewProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>
Optional callback: (() => void)
Returns void
Returns void
Optional should
Parameters
prevProps: Readonly<GroupCallVideoViewProps>
prevState: Readonly<{}>
Returns any
render
Returns Element
set
Type Parameters
K extends never
Parameters
state: null | {} | ((prevState: Readonly<{}>, props: Readonly<GroupCallVideoViewProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>
Optional callback: (() => void)
Returns void
Returns void
Optional should
Called to determine whether the change in props and state should trigger a re-render.
Componentalways returns true.PureComponentimplements a shallow comparison on props and state and returns true if any diff --git a/docs/classes/LocalParticipant.html b/docs/classes/LocalParticipant.html index 92eef86..b0f33f4 100644 --- a/docs/classes/LocalParticipant.html +++ b/docs/classes/LocalParticipant.html @@ -1,24 +1,24 @@ -- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass LocalParticipant
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
props: ParticipantProperties
binder: default
internalEvents: InternalEvents<RoomListener>
roomId: string
Returns LocalParticipant
Accessors
duration
Returns number
entered
Returns number
exited
Returns number
is
Returns boolean
is
Returns boolean
participant
Returns string
state
Returns ParticipantState
updated
Returns number
user
Returns User
Methods
mute
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass LocalParticipant
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
props: ParticipantProperties
binder: default
internalEvents: InternalEvents<RoomListener>
roomId: string
Returns LocalParticipant
Accessors
duration
Returns number
entered
Returns number
exited
Returns number
is
Returns boolean
is
Returns boolean
participant
Returns string
state
Returns ParticipantState
updated
Returns number
user
Returns User
Methods
mute
Mutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.
1.0.0
-Returns void
start
Returns void
start
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.
1.0.0
-Returns void
stop
Returns void
stop
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.
1.0.0
-Returns void
switch
Returns void
switch
Toggles the selection between the front and the back camera.
on Android, In case of more than two cameras, the next camera will be selected. If the last camera is already selected, the first one will be selected again.
1.0.0
-Returns Promise<void>
unmute
Returns Promise<void>
unmute
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.
diff --git a/docs/classes/Participant.html b/docs/classes/Participant.html index 8a1a048..332b073 100644 --- a/docs/classes/Participant.html +++ b/docs/classes/Participant.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass Participant
Hierarchy
Implements
Index
Constructors
Accessors
Constructors
constructor
Parameters
props: ParticipantProperties
Returns Participant
Accessors
duration
Returns number
entered
Returns number
exited
Returns number
is
Returns boolean
is
Returns boolean
participant
Returns string
state
Returns ParticipantState
updated
Returns number
user
Returns User
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass Participant
Hierarchy
Implements
Index
Constructors
Accessors
Constructors
constructor
Parameters
props: ParticipantProperties
Returns Participant
Accessors
duration
Returns number
entered
Returns number
exited
Returns number
is
Returns boolean
is
Returns boolean
participant
Returns string
state
Returns ParticipantState
updated
Returns number
user
Returns User
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass Room
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
binder: default
props: RoomProperties
Returns Room
Accessors
android_
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass Room
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
binder: default
props: RoomProperties
Returns Room
Accessors
android_
Gets available audio devices.
-Returns AudioDeviceType[]
android_
Returns AudioDeviceType[]
android_
Gets current audio device.
-Returns null | AudioDeviceType
created
Returns null | AudioDeviceType
created
Gets createdAt that is a timestamp of creating the room.
-Returns number
created
Returns number
created
Gets user ID created the room.
-Returns string
custom
Returns string
custom
Gets custom items of this Room instance.
-Returns Record<string, string>
local
Returns Record<string, string>
local
Gets the local participant.
-Returns null | LocalParticipant
participants
Returns null | LocalParticipant
participants
Gets a list of participants who entered the room.
-Returns Participant[]
remote
Returns Participant[]
remote
Gets a list of remote participants who entered the room.
-Returns Participant[]
room
Returns Participant[]
room
Gets room ID.
-Returns string
state
Returns string
state
Gets state of room.
-Returns RoomState
type
Returns RoomState
type
Gets type of room.
-Returns RoomType
Methods
add
Returns RoomType
Methods
add
Add GroupCall Room listener. supports multiple listeners.
1.0.0
-Parameters
listener: Partial<RoomListener>
Returns (() => void)
Returns void
android_
Parameters
listener: Partial<RoomListener>
Returns (() => void)
Returns void
android_
Selects audio device Changes current audio device asynchronously. Will trigger RoomListener.onAudioDeviceChanged method of the local participant after successfully changing the audio device.
Android
1.0.0
-Parameters
device: AudioDeviceType
Returns Promise<void>
enter
Parameters
device: AudioDeviceType
Returns Promise<void>
enter
Enter the room Will trigger RoomListener.onRemoteParticipantEntered method of remote participants after successfully entering the room. If a remote participant entered the room, the local user will be notified via the same method.
1.0.0
-Parameters
options: EnterParams = ...
Returns Promise<void>
exit
Parameters
options: EnterParams = ...
Returns Promise<void>
exit
Exit from the room Will trigger RoomListener.onRemoteParticipantExited method of remote participants after successfully exiting the room. If a remote participant exited the room, the local user will be notified via the same method.
diff --git a/docs/classes/RoomListQuery.html b/docs/classes/RoomListQuery.html index b0d4d05..da182df 100644 --- a/docs/classes/RoomListQuery.html +++ b/docs/classes/RoomListQuery.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass RoomListQuery
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
queryKey: `native#${string}`
type: ROOM_LIST
binder: default
Returns RoomListQuery
Accessors
has
Returns boolean
is
Returns boolean
Methods
next
Returns Promise<RoomProperties[]>
release
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass RoomListQuery
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
queryKey: `native#${string}`
type: ROOM_LIST
binder: default
Returns RoomListQuery
Accessors
has
Returns boolean
is
Returns boolean
Methods
next
Returns Promise<RoomProperties[]>
release
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@sendbird/calls-react-nativeClass SendbirdCallsModule
SendbirdCallsModule class for SendbirdCalls
-Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
binder: default
Returns SendbirdCallsModule
Accessors
Logger
Hierarchy
Implements
Index
Constructors
Accessors
Methods
Constructors
constructor
Parameters
binder: default
Returns SendbirdCallsModule
Accessors
Logger
Returns the SDK Logger
1.0.0
-Returns { error: ((...args: unknown[]) => number); getLogLevel: (() => "none" | "error" | "warning" | "info"); info: ((...args: unknown[]) => number); setLogLevel: ((level: "none" | "error" | "warning" | "info") => void); warn: ((...args: unknown[]) => number) }
error: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
get
Returns "none" | "error" | "warning" | "info"
info: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
set
Parameters
level: "none" | "error" | "warning" | "info"
Returns void
warn: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
NATIVE_
Returns { error: ((...args: unknown[]) => number); getLogLevel: (() => "none" | "error" | "warning" | "info"); info: ((...args: unknown[]) => number); setLogLevel: ((level: "none" | "error" | "warning" | "info") => void); warn: ((...args: unknown[]) => number) }
error: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
get
Returns "none" | "error" | "warning" | "info"
info: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
set
Parameters
level: "none" | "error" | "warning" | "info"
Returns void
warn: ((...args: unknown[]) => number)
Parameters
Rest ...args: unknown[]
Returns number
NATIVE_
Returns current iOS/Android SDK version.
1.0.0
-Returns string
Room
Returns string
Room
An enum that represents state of a room. Returns RoomState
1.0.0
-Returns typeof RoomState
Room
Returns typeof RoomState
Room
An enum that represents different types of a room. Returns RoomType
1.0.0
-Returns typeof RoomType
VERSION
Returns typeof RoomType
VERSION
Returns current React-Native SDK version.
1.0.0
-Returns string
application
Returns string
application
Returns current application ID.
1.0.0
-Returns string
current
Returns string
current
Gets the current
User. Returns the currentUser. If SendbirdCalls is not authenticated,nullwill be returned.1.0.0
-Returns null | User
initialized
Returns null | User
initialized
Returns is SDK initialized.
1.0.0
-Returns boolean
Methods
add
Returns boolean
Methods
add
Adds sound used in DirectCall such as ringtone and some sound effects with its file name with extension
bundle file name
res/raw file name
1.0.0
-Parameters
type: SoundType
fileName: string
Returns void
android_
Parameters
type: SoundType
fileName: string
Returns void
android_
Handles Firebase message data. Returns true if Sendbird call message. Otherwise false.
Android
1.0.0
-Parameters
Optional data: Record<string, string>
Returns boolean
authenticate
Parameters
Optional data: Record<string, string>
Returns boolean
authenticate
Authenticates.
1.0.0
-Parameters
authParams: AuthenticateParams
Returns Promise<User>
create
Parameters
authParams: AuthenticateParams
Returns Promise<User>
create
Creates direct call log list query.
1.0.0
-Parameters
params: DirectCallLogQueryParams = {}
Returns Promise<DirectCallLogListQuery>
create
Parameters
params: DirectCallLogQueryParams = {}
Returns Promise<DirectCallLogListQuery>
create
Creates a Room for group calls.
1.0.0
-Parameters
roomParams: RoomParams
Returns Promise<Room>
create
Parameters
roomParams: RoomParams
Returns Promise<Room>
create
Creates a query for room list with specified parameters.
1.0.0
-Parameters
params: RoomListQueryParams = {}
Returns Promise<RoomListQuery>
deauthenticate
Parameters
params: RoomListQueryParams = {}
Returns Promise<RoomListQuery>
deauthenticate
Deauthenticates.
1.0.0
-Returns Promise<void>
dial
Returns Promise<void>
dial
Makes a call to user(callee) directly. (1:1 Call). Use the CallOptions object to choose initial call configuration (e.g. muted/unmuted)
1.0.0
-Parameters
calleeUserId: string
isVideoCall: boolean
options: CallOptions = ...
Returns Promise<DirectCallProperties>
fetch
Parameters
calleeUserId: string
isVideoCall: boolean
options: CallOptions = ...
Returns Promise<DirectCallProperties>
fetch
Fetches a room instance from Sendbird server.
1.0.0
-Parameters
roomId: string
Returns Promise<Room>
get
Parameters
roomId: string
Returns Promise<Room>
get
Gets a locally-cached room instance by room ID.
1.0.0
-Parameters
roomId: string
Returns Promise<null | Room>
get
Parameters
roomId: string
Returns Promise<null | Room>
get
Gets the current
Userfrom native Returns the currentUser. If SendbirdCalls is not authenticated,nullwill be returned.1.0.0
-Returns Promise<null | User>
get
Returns Promise<null | User>
get
Gets call from call ID or call UUID
1.0.0
-Parameters
callId: string
Returns Promise<DirectCall>
get
Parameters
callId: string
Returns Promise<DirectCall>
get
Returns all ongoing calls, including the active call and all calls on hold.
1.0.0
-Returns Promise<DirectCallProperties[]>
initialize
Returns Promise<DirectCallProperties[]>
initialize
Initializes SendbirdCalls.
1.0.0
-Parameters
appId: string
Returns boolean
ios_
Parameters
appId: string
Returns boolean
ios_
To receive native-like calls while an app is in the background or closed, a device registration token must be registered to the server. Register a device push token after authentication has completed using the
SendbirdCalls.ios_registerVoIPPushToken()method.iOS
1.0.0
-Parameters
token: string
unique: boolean = true
Returns Promise<void>
ios_
Parameters
token: string
unique: boolean = true
Returns Promise<void>
ios_
Show-up a view that allows user to change the system audio route. AVRoutePickerView in iOS 11 or later
iOS
1.0.0
-Returns void
ios_
Returns void
ios_
Unregisters a VoIP push token of specific device. You will not receive VoIP push notification for a call anymore.
iOS
1.0.0
-Parameters
token: string
Returns Promise<void>
register
Parameters
token: string
Returns Promise<void>
register
Registers push token for current user.
on iOS, push token means APNS token. on Android, push token means FCM token.
1.0.0
-Parameters
token: string
unique: boolean = true
Returns Promise<void>
remove
Parameters
token: string
unique: boolean = true
Returns Promise<void>
remove
Removes sound used in DirectCall with SoundType value.
1.0.0
-Parameters
type: SoundType
Returns void
set
Parameters
type: SoundType
Returns void
set