ConferenceCreateOptions.Builder

The ConferenceCreateOptions.Builder model allows the application to:

Create a new builder.
Create the ConferenceCreateOptions instance.
Set the conference alias and parameters.
Create Dolby Voice conferences.

Available in the package com.voxeet.sdk.services.builders.ConferenceCreateOptions.Builder.

Constructors

Builder

▸ Builder()

Creates a new builder.

Methods

setConferenceAlias

▸ setConferenceAlias(@Nullable conferenceAlias: String): ConferenceCreateOptions.Builder

Sets the conference alias. The alias needs to be a logical and unique string that consists of up to 250 characters, such as letters, digits, and symbols other than #. The alias is case insensitive, which means that using "foobar" and "FOObar" aliases refers to the same conference.

Parameters

Name	Type	Description
conferenceAlias	String	nullable conference name, preferably non-null

Returns: ConferenceCreateOptions.Builder - the builder instance.

setParamsHolder

▸ setParamsHolder(@Nullable paramsHolder: ParamsHolder): ConferenceCreateOptions.Builder

Adds parameters to the conference.

Parameters

Name	Type	Description
paramsHolder	ParamsHolder	nullable reference to parameters

Returns: ConferenceCreateOptions.Builder - the builder instance.

addParam

▸ addParam(@NonNull key: String, @Nullable value: Object): ConferenceCreateOptions.Builder

Adds a parameter value to the builder. This method automatically integrates the Conference Parameter object and inserts the provided dolbyVoice parameter to the object. For more information about Dolby Voice, see this article.
The following example presents how to use the addParam method to create the Dolby Voice conference.

VoxeetSDK.conference().create(
  new ConferenceCreateOptions.Builder()
    .setConferenceAlias(conference_alias)
    .addParam("dolbyVoice", true).build()
).then(createConferenceresult -> {
  //manage the success here
}).error(error -> {
  //manage the error here
});

Note: To create the Dolby Voice conference, you can also use the setDolbyVoice method.

Parameters

Name	Type	Description
key	String	non null
value	Object	nullable

Returns: ConferenceCreateOptions.Builder

build

▸ build(): ConferenceCreateOptions

Constructs the ConferenceCreateOptions instance for creating conferences.

Returns: @NonNull ConferenceCreateOptions - the builder instance.