SendBirdCall

object SendBirdCall

SendBirdCall

Since

0.6.0

Types

Options
Link copied to clipboard
object Options

Represents operation options.

SoundType
Link copied to clipboard
enum SoundType : Enum<SendBirdCall.SoundType>

SoundType

Functions

addListener
Link copied to clipboard
fun addListener(identifier: String, listener: SendBirdCallListener)

Adds listener.

addRecordingListener
Link copied to clipboard
fun addRecordingListener(identifier: String, listener: RecordingListener)

Adds a RecordingListener to the SDK which is invoked when a recording session is finished successfully.

authenticate
Link copied to clipboard
fun authenticate(params: AuthenticateParams, handler: AuthenticateHandler?)

Authenticates.

createDirectCallLogListQuery
Link copied to clipboard

Creates direct call log list query.

createRoom
Link copied to clipboard
fun createRoom(params: RoomParams, handler: RoomHandler?)

Creates a Room for group calls.

createRoomListQuery
Link copied to clipboard
fun createRoomListQuery(params: RoomListQuery.Params): RoomListQuery

Creates a query for room list with specified parameters.

deauthenticate
Link copied to clipboard
fun deauthenticate(handler: CompletionHandler?)

Deauthenticates.

deleteAllCustomItems
Link copied to clipboard
fun deleteAllCustomItems(callId: String, handler: CustomItemsHandler?)

Deletes all custom items.

deleteCustomItems
Link copied to clipboard
fun deleteCustomItems(callId: String, customItemKeys: Set<String>, handler: CustomItemsHandler?)

Deletes custom items.

dial
Link copied to clipboard
fun dial(params: DialParams, handler: DialHandler?): DirectCall?

Dials.

fetchRoomById
Link copied to clipboard
fun fetchRoomById(roomId: String, handler: RoomHandler?)

Fetches a room instance from Sendbird server.

getCachedRoomById
Link copied to clipboard
fun getCachedRoomById(roomId: String): Room?

Gets a locally-cached room instance by room ID.

getCall
Link copied to clipboard
fun getCall(callId: String): DirectCall?

Gets call from call ID.

getRoomInvitation
Link copied to clipboard
fun getRoomInvitation(roomInvitationId: String): RoomInvitation?
getSdkVersion
Link copied to clipboard
fun getSdkVersion(): String

Returns SDK version.

handleFirebaseMessageData
Link copied to clipboard
fun handleFirebaseMessageData(data: Map<String, String>): Boolean

Handles Firebase message data.

handleHmsMessageData
Link copied to clipboard
fun handleHmsMessageData(data: Map<String, String>): Boolean

Handles Huawei mobile services message data.

handleWebhookCommand
Link copied to clipboard
fun handleWebhookCommand(payload: String): Boolean

Handles a webhook command.

init
Link copied to clipboard
fun init(context: Context, appId: String): Boolean

Initializes SendBird Call.

registerPushToken
Link copied to clipboard
fun registerPushToken(pushToken: String, unique: Boolean, handler: CompletionHandler?)
fun registerPushToken(pushToken: String, pushTokenType: PushTokenType, unique: Boolean, handler: CompletionHandler?)

Registers push token for current user.

removeAllListeners
Link copied to clipboard
fun removeAllListeners()

Removes all listeners.

removeAllRecordingListeners
Link copied to clipboard
fun removeAllRecordingListeners()

Removes all RecordingListeners from the SDK.

removeListener
Link copied to clipboard
fun removeListener(identifier: String): SendBirdCallListener?

Removes listener.

removeRecordingListener
Link copied to clipboard
fun removeRecordingListener(identifier: String): RecordingListener?

Removes a RecordingListener that has the specified identifier from the SDK.

retrieveMissedDirectCalls
Link copied to clipboard
fun retrieveMissedDirectCalls(handler: CompletionHandler?)

Retrieves pending events from the server that were missed from the device. If there are incoming calls that were not received via push notifications, the missed calls will be given in the SendBirdCallListener.onRinging method.

setLoggerLevel
Link copied to clipboard
fun setLoggerLevel(level: Int)

Sets logger level.

unregisterAllPushTokens
Link copied to clipboard
fun unregisterAllPushTokens(handler: CompletionHandler?)
fun unregisterAllPushTokens(pushTokenType: PushTokenType, handler: CompletionHandler?)

Unregisters all push tokens for current user.

unregisterPushToken
Link copied to clipboard
fun unregisterPushToken(pushToken: String, handler: CompletionHandler?)
fun unregisterPushToken(pushToken: String, pushTokenType: PushTokenType, handler: CompletionHandler?)

Unregisters push token for current user.

updateCustomItems
Link copied to clipboard
fun updateCustomItems(callId: String, customItems: Map<String, String>, handler: CustomItemsHandler?)

Updates custom items.

Properties

applicationId
Link copied to clipboard
var applicationId: String

Returns current application ID.

currentUser
Link copied to clipboard
val currentUser: User?

Gets the current User.

incomingCalls
Link copied to clipboard
val incomingCalls: List<DirectCall>

Returns all incoming calls

LOGGER_ERROR
Link copied to clipboard
const val LOGGER_ERROR: Int = 1
LOGGER_INFO
Link copied to clipboard
const val LOGGER_INFO: Int = 3

LOGGER_INFO

LOGGER_NONE
Link copied to clipboard
const val LOGGER_NONE: Int = 0
LOGGER_WARNING
Link copied to clipboard
const val LOGGER_WARNING: Int = 2

LOGGER_WARNING

ongoingCallCount
Link copied to clipboard
val ongoingCallCount: Int

Gets ongoing call count.

ongoingCalls
Link copied to clipboard
val ongoingCalls: List<DirectCall>

Returns all ongoing calls, including the active call and all calls on hold.

VERSION
Link copied to clipboard
const val VERSION: String

Returns current SDK version.