Class ConferenceParameter

  • ConferenceParameter objects store solution-specific parameters for add-ons, persisting with conference data and utilized for updates or deletions.

  • Developers can use the setKey(key) method to assign a key (up to 50 characters) and setValue(value) to assign a value (up to 1024 characters) to these parameters.

  • Both setKey and setValue methods return the ConferenceParameter object, allowing for chained method calls for efficient setup.

  • Exceeding the maximum length for keys or values when using setKey(key) or setValue(value) will result in an error.

ConferenceParameter

Solution-specific parameter available fo the add-on's use. This parameter is persisted with the conference data and, if an update or delete is needed, is passed to the add-on. Example usage:

const conferenceParameter = ConferenceDataService.newConferenceParameter()
                                .setKey('meetingId')
                                .setValue('123456');

Methods

MethodReturn typeBrief description
setKey(key)ConferenceParameterSets the key of this ConferenceParameter.
setValue(value)ConferenceParameterSets the value of this ConferenceParameter.

Detailed documentation

setKey(key)

Sets the key of this ConferenceParameter. The maximum length for this field is 50 characters. Required.

Parameters

NameTypeDescription
keyStringThe key to set.

Return

ConferenceParameter — this object, for chaining

Throws

Error — if the provided key is too long.


setValue(value)

Sets the value of this ConferenceParameter. The maximum length for this field is 1024 characters. Required.

Parameters

NameTypeDescription
valueStringThe value to set.

Return

ConferenceParameter — this object, for chaining

Throws

Error — if the provided value is too long.