Bubbles

interface Bubbles

This module is used to manage bubbles.

A bubble is also called a room. This is exactly the same object.

Types

Companion
Link copied to clipboard
object Companion
interface IAddParticipantsAndStartConferenceListener
IEchoTestListener
Link copied to clipboard
interface IEchoTestListener
IOpenInviteChangeListener
Link copied to clipboard
interface IOpenInviteChangeListener
IRoomFoundListener
Link copied to clipboard
interface IRoomFoundListener
IRoomRefreshListener
Link copied to clipboard
interface IRoomRefreshListener
ISearchRoomListener
Link copied to clipboard
interface ISearchRoomListener
IUserInConferenceListener
Link copied to clipboard
interface IUserInConferenceListener

Functions

acceptInvitation
Link copied to clipboard
abstract fun acceptInvitation(room: Room?, listener: IRoomProxy.IChangeUserRoomDataListener?)
Accept an invitation to join a bubble.
addParticipantsAndStartConference
Link copied to clipboard
abstract fun addParticipantsAndStartConference(currentCall: WebRTCCall, participants: <ERROR CLASS><IRainbowContact>, listener: Bubbles.IAddParticipantsAndStartConferenceListener)
Escalate a P2P call to a conference by adding participants
addParticipantsToBubble
Link copied to clipboard
abstract fun addParticipantsToBubble(room: Room?, contactsList: <ERROR CLASS><IRainbowContact>?, listener: IRoomProxy.IAddParticipantsListener?)
Add a list of participants to a bubble with invitations and as users.
abstract fun addParticipantsToBubble(room: Room?, contactsList: <ERROR CLASS><IRainbowContact>?, asModerators: Boolean, withInvitations: Boolean, listener: IRoomProxy.IAddParticipantsListener?)
Add a list of participants to a bubble.
addParticipantToBubble
Link copied to clipboard
abstract fun addParticipantToBubble(room: Room?, contact: IRainbowContact?, listener: IRoomProxy.IAddParticipantsListener?)
Add one participant to a bubble with invitation and as a user.
abstract fun addParticipantToBubble(room: Room?, contact: IRainbowContact?, asModerator: Boolean, withInvitation: Boolean, listener: IRoomProxy.IAddParticipantsListener?)
Add one participant to a bubble.
addPhoneNumberParticipant
Link copied to clipboard
abstract fun addPhoneNumberParticipant(room: Room, number: String?, listener: IResultListener?)
Call a number to add it to an ongoing conference
archiveBubble
Link copied to clipboard
abstract fun archiveBubble(room: Room, listener: IRoomProxy.IChangeRoomDataListener?)
Archive a bubble, Two possible cases:
  1. If you are the owner, all participants are archived.

  2. If you are NOT the owner, you just leave the bubble.

abstract fun archiveBubble(room: Room, listener: IRoomProxy.IChangeUserRoomDataListener?)
Archive a bubble.
cancelInvitationGuestsToBubble
Link copied to clipboard
abstract fun cancelInvitationGuestsToBubble(room: Room?, guests: List<String?>?, listener: IRoomProxy.ICancelInviteToJoinRoom?)
Cancel guests invitation to a bubble
changeBubbleData
Link copied to clipboard
abstract fun changeBubbleData(room: Room?, name: String?, topic: String?, visibility: Boolean, participantsMuted: Boolean, entryToneActivated: Boolean, autoRegister: Room.AutoRegisterType?, listener: IRoomProxy.IChangeRoomDataListener?)
Update bubble properties like the name, the topic or the visibility.
changeOwner
Link copied to clipboard
abstract fun changeOwner(room: Room, ownerId: String?, listener: IRoomProxy.IChangeRoomDataListener?)
Change the owner of a bubble
checkServicePlan
Link copied to clipboard
abstract fun checkServicePlan(room: Room?, contact: IRainbowContact?, listener: IRoomProxy.ICheckServicePlanListener?)
Check if the given contact can be used for changing the owner of the Bubble
checkUserAlreadyInConference
Link copied to clipboard
abstract fun checkUserAlreadyInConference(room: Room, listener: Bubbles.IUserInConferenceListener)
Let you know you if the user is already connected in the conference associated to a bubble
createAutoAcceptedBubble
Link copied to clipboard
abstract fun createAutoAcceptedBubble(name: String?, description: String?, withHistory: Boolean, disableNotifications: Boolean, participantsMuted: Boolean, entryToneActivated: Boolean, listener: IRoomProxy.IRoomCreationListener?)
Create a bubble with a name, a description, with or not history and if the notifications are enabled or not.
createBubble
Link copied to clipboard
abstract fun createBubble(name: String?, description: String?, disableNotifications: Boolean, participantsMuted: Boolean, entryToneActivated: Boolean, listener: IRoomProxy.IRoomCreationListener?)
Create a bubble with a name, a description and if the notifications are enabled or not.
abstract fun createBubble(name: String?, description: String?, withHistory: Boolean, disableNotifications: Boolean, participantsMuted: Boolean, entryToneActivated: Boolean, listener: IRoomProxy.IRoomCreationListener?)
Create a bubble with a name, a description, with or not history and if the notifications are enabled or not.
declineWebConferenceCall
Link copied to clipboard
abstract fun declineWebConferenceCall(room: Room)
Let you decline a conference so that it stops ringing on all devices
delegateConference
Link copied to clipboard
abstract fun delegateConference(room: Room, conferenceParticipant: ConferenceParticipant, hangupCall: Boolean = false, listener: IConferenceProxy.IDelegateConferenceListener?)
Delegate an ongoing conference from the user to another participant.
deleteAllCustomDataForBubble
Link copied to clipboard
abstract fun deleteAllCustomDataForBubble(room: Room?, listener: IRoomProxy.IUpdateCustomDataListener?)
Delete all the customData of a bubble.
deleteBubble
Link copied to clipboard
abstract fun deleteBubble(room: Room?, listener: IRoomProxy.IDeleteRoomListener?)
Delete a bubble.
deleteParticipantFromBubble
Link copied to clipboard
abstract fun deleteParticipantFromBubble(room: Room?, contact: IRainbowContact?, keepArchive: Boolean, listener: IRoomProxy.IDeleteParticipantListener?)
Delete one participant from a bubble.
findBubbleById
Link copied to clipboard
abstract fun findBubbleById(roomId: String?): Room?
Get a bubble from its id.
findBubbleByJid
Link copied to clipboard
abstract fun findBubbleByJid(roomJid: String?): Room?
Get a bubble from its jid.
findBubblesByName
Link copied to clipboard
abstract fun findBubblesByName(name: String?): List<Room>
Get a bubble from its name.
getAllBubbles
Link copied to clipboard
abstract fun getAllBubbles(): ArrayItemList<Room>
Get all bubbles (including archived and pending).
getAllList
Link copied to clipboard
abstract fun getAllList(): <ERROR CLASS><Room>
Get all bubbles except pending and archived.
getAllTags
Link copied to clipboard
abstract fun getAllTags(listener: IRoomProxy.IUpdateRoomTagsListener?)
Fetch all tags from all users Bubbles at server side
getArchivedList
Link copied to clipboard
abstract fun getArchivedList(): <ERROR CLASS><Room>
Get archived bubbles.
getAvatarUrl
Link copied to clipboard
abstract fun getAvatarUrl(room: Room?, resolution: Int): String?
Get the avatar URL of a contact
getBubbleByConferenceId
Link copied to clipboard
abstract fun getBubbleByConferenceId(confId: String?): Room?
Return a @object:Room object of the conference id passed in parameterThis is only working for local bubbles.
getConferenceTalkingTime
Link copied to clipboard
abstract fun getConferenceTalkingTime(room: Room, listener: IConferenceProxy.IGetConferenceTalkingTimeListener?)
Get a list of participants and their talking time from the last conference of the Bubble in parameter.
getMoreActiveUsersFromBubble
Link copied to clipboard
abstract fun getMoreActiveUsersFromBubble(roomId: String?, nbParticipantsToRetrieve: Int, listener: IRoomProxy.IGetActiveUserFromRoomListener?)
Get the nbParticipantsToRetrieve next participants in a bubble, based on the locale list.
getMyInactiveList
Link copied to clipboard
abstract fun getMyInactiveList(): <ERROR CLASS><Room>
Get inactive bubbles.
getMyList
Link copied to clipboard
abstract fun getMyList(): <ERROR CLASS><Room>
Get bubbles owned by the connected user.
getPendingList
Link copied to clipboard
abstract fun getPendingList(): <ERROR CLASS><Room>
Get pending bubbles.
getPublicLinkForBubble
Link copied to clipboard
abstract fun getPublicLinkForBubble(bubbleId: String?, listener: IUserProxy.IGetOpenInviteListener?)
Get the public link for a given bubble.
getRoomData
Link copied to clipboard
abstract fun getRoomData(room: Room?, listener: IRoomProxy.IGetRoomDataListener?)
Let you refresh a bubble
getUserQuotaConsumption
Link copied to clipboard
abstract fun getUserQuotaConsumption(listener: IRoomProxy.IGetConsumptionListener?)
Get a Consumption object which allows to get the current bubble quota and consumption for the connected user
hangUpParticipant
Link copied to clipboard
abstract fun hangUpParticipant(room: Room, participant: ConferenceParticipant?, listener: IConferenceProxy.IHangUpParticipantListener?)
hangup a participant in a conference
inviteGuestsToBubble
Link copied to clipboard
abstract fun inviteGuestsToBubble(room: Room?, guests: List<String?>?, listener: IRoomProxy.IInviteToJoinRoom?)
Add guests to a bubble with invitation
inviteUsersToBubble
Link copied to clipboard
abstract fun inviteUsersToBubble(room: Room?, contactsList: <ERROR CLASS><IRainbowContact>?, listener: IRoomProxy.IInviteToJoinRoom?)
Invite a list of participants to a bubble.
isConferenceJoinable
Link copied to clipboard
abstract fun isConferenceJoinable(room: Room?): Boolean
This method allows to know if a conference is joinable or not.
joinAudioConference
Link copied to clipboard
abstract fun joinAudioConference(room: Room?, phoneNumber: String?, listener: IConferenceProxy.IJoinAudioCallListener?)
Join conference in audio mode : this method is called when a conference is already started.
joinBubbleByOpenInviteId
Link copied to clipboard
abstract fun joinBubbleByOpenInviteId(openInviteId: String?, listener: IRoomProxy.IJoinRoomByOpenInvite?)
Let the user join a shared Bubble with the id from its public link
leaveBubble
Link copied to clipboard
abstract fun leaveBubble(room: Room?, listener: IRoomProxy.IDeleteParticipantListener?)
Leave a room.
loadAllBubblesParticipantIfNeeded
Link copied to clipboard
abstract fun loadAllBubblesParticipantIfNeeded(room: Room)
By default, only active or invited participants are loaded in a Bubble.
lockConference
Link copied to clipboard
abstract fun lockConference(room: Room, lockState: Boolean)
Let you lock a conference so that no other participant can join it
mergeCalls
Link copied to clipboard
abstract fun mergeCalls(calls: List<WebRTCCall>, listener: Bubbles.IAddParticipantsAndStartConferenceListener)
Merge several phone calls (P2P or PBX calls) into a conference.
muteAllParticipants
Link copied to clipboard
abstract fun muteAllParticipants(room: Room, mute: Boolean, listener: IConferenceProxy.IToggleMuteStateParticipantListener?)
mute / unmute all participants of the conference
refreshAllBubbles
Link copied to clipboard
abstract fun refreshAllBubbles(listener: Bubbles.IRoomRefreshListener?)
Refresh all active bubbles from server.
refreshArchivedBubbles
Link copied to clipboard
abstract fun refreshArchivedBubbles(listener: Bubbles.IRoomRefreshListener?)
Refresh all archived bubbles from server.
registerPublicLinkSharingChangeListener
Link copied to clipboard
abstract fun registerPublicLinkSharingChangeListener(listener: Bubbles.IOpenInviteChangeListener)
Registers to all changes on public link (activation/deactivation) of your bubbles.
rejectInvitation
Link copied to clipboard
abstract fun rejectInvitation(room: Room?, listener: IRoomProxy.IChangeUserRoomDataListener?)
Reject an invitation to join a bubble.
reSubscribeToVideo
Link copied to clipboard
abstract fun reSubscribeToVideo(room: Room, publisher: ConferenceParticipant, listener: IConferenceProxy.ISubscribeParticipantVideoListener?)
When a conference is started, it is possible to resubscribe to a video using this method.
searchRoomsByName
Link copied to clipboard
abstract fun searchRoomsByName(textToSearch: String?, listener: Bubbles.ISearchRoomListener?)
Let you search Bubbles by name.
searchRoomsByTag
Link copied to clipboard
abstract fun searchRoomsByTag(textToSearch: String?, listener: Bubbles.ISearchRoomListener?)
Let you search Bubbles by tag name.
setParticipantPrivilegeToGuest
Link copied to clipboard
abstract fun setParticipantPrivilegeToGuest(room: Room?, contact: IRainbowContact?, listener: IRoomProxy.IChangeUserRoomDataListener?)
Set the privilege of a participant to guest.
setParticipantPrivilegeToModerator
Link copied to clipboard
abstract fun setParticipantPrivilegeToModerator(room: Room?, contact: IRainbowContact?, listener: IRoomProxy.IChangeUserRoomDataListener?)
Set the privilege of a participant to moderator (promote).
setParticipantPrivilegeToUser
Link copied to clipboard
abstract fun setParticipantPrivilegeToUser(room: Room?, contact: IRainbowContact?, listener: IRoomProxy.IChangeUserRoomDataListener?)
Set the privilege of a participant to user (demote).
shareBubbleByLink
Link copied to clipboard
abstract fun shareBubbleByLink(bubbleId: String?, listener: IUserProxy.IGetOpenInviteListener?)
Share the bubble by public link.
startAndJoinConference
Link copied to clipboard
abstract fun startAndJoinConference(room: Room, listener: IConferenceProxy.IJoinAudioCallListener?)
If the user is the owner's bubble, the user will start the conference and will join the conference.
startEchoTest
Link copied to clipboard
abstract fun startEchoTest(listener: Bubbles.IEchoTestListener)
Start an echo test to check the audio quality and the connectivity.
stopAudioConference
Link copied to clipboard
abstract fun stopAudioConference(room: Room, listener: IConferenceProxy.IStopAudioConfListener?)
stop conference.
stopEchoTest
Link copied to clipboard
abstract fun stopEchoTest()
Stop the current echo test if present
stopSharingBubbleByLink
Link copied to clipboard
abstract fun stopSharingBubbleByLink(bubbleId: String?, listener: IUserProxy.IGetOpenInviteListener?)
Deactivate the sharing of the bubble by public link.
subscribeToVideo
Link copied to clipboard
abstract fun subscribeToVideo(room: Room, publisher: ConferenceParticipant?, multiVideoQuality: ConferenceParticipant.MultiVideoQuality?, activeSpeaker: Boolean, listener: IConferenceProxy.ISubscribeParticipantVideoListener?)
when a conference is started,it is possible to subscribe to video using this method
toggleMuteStateParticipant
Link copied to clipboard
abstract fun toggleMuteStateParticipant(room: Room, participant: ConferenceParticipant?, listener: IConferenceProxy.IToggleMuteStateParticipantListener?)
mute : unmute participant
abstract fun unregisterPublicLinkSharingChangeListener(listener: Bubbles.IOpenInviteChangeListener)
Unregisters to all changes on public link (activation/deactivation) of your bubbles.
unsubscribeToVideo
Link copied to clipboard
abstract fun unsubscribeToVideo(room: Room, publisher: ConferenceParticipant?)
When a conference is started, it is possible to unsubscribe to a video using this method.
updateCustomDataForBubble
Link copied to clipboard
abstract fun updateCustomDataForBubble(room: Room?, customData: JSONObject?, listener: IRoomProxy.IUpdateCustomDataListener?)
Update the customData of a bubble.
updateLocalVideoMaxBandwidth
Link copied to clipboard
abstract fun updateLocalVideoMaxBandwidth(room: Room, maxBandwidth: Int, listener: IConferenceProxy.IUpdateVideoQualityListener?)
Request to update the maximum bandwidth of the sent video stream.
updateRoomTags
Link copied to clipboard
abstract fun updateRoomTags(tags: List<String?>, bubbleId: String, listener: IRoomProxy.IUpdateRoomTagsListener?)
Add, update or delete tags for a specified Room
updateVideoQuality
Link copied to clipboard
abstract fun updateVideoQuality(room: Room, videoPublisher: ConferenceParticipant?, newMultiVideoQuality: ConferenceParticipant.MultiVideoQuality?, listener: IConferenceProxy.IUpdateVideoQualityListener?)
Request to update the video quality of the video publisher.
uploadRoomAvatar
Link copied to clipboard
abstract fun uploadRoomAvatar(room: Room?, listener: IRoomProxy.IRoomAvatarListener?)
change Photo of Meeting
abstract fun uploadRoomAvatar(room: Room?, photoFile: File?, listener: IRoomProxy.IRoomAvatarListener?)
change Photo of Meeting