com.adobe.connectpro.telephony.adaptor
Class TelephonyUserInfo

java.lang.Object
  com.adobe.connectpro.telephony.adaptor.TelephonyUserInfo

public class TelephonyUserInfo
extends java.lang.Object

Data class containing values of different options for a phone user within a conference.

Nested Class Summary

static class

TelephonyUserInfo.UserType Type of phone user, determined by the way in which the user joins the conference

Constructor Summary

TelephonyUserInfo(java.lang.String telephonyUserId)
Single argument Constructor.

TelephonyUserInfo(java.lang.String telephonyUserId, java.lang.String phoneNumber, java.lang.String telephonyToken, java.lang.String subconferenceId, TelephonyUserInfo.UserType userType, boolean isSpeaking, boolean isVideo)
Constructor with all information except option.

Method Summary

java.lang.String	getCustomOption(java.lang.String optionName) Returns custom user options.
java.lang.String[]	getCustomOptionNames() Returns custom user option names.
java.lang.String	getOption(UserOption optionName) Returns user options.
java.lang.String	getPhoneNumber() Returns the user's phone number.
java.lang.String	getSubconferenceId() Returns the subconference the phone user is in, when audio breakouts are in use.
java.lang.String	getTelephonyToken() Returns the user's telephony token.
java.lang.String	getTelephonyUserId() Returns the user's telephony identifier, which is generated by the adaptor
TelephonyUserInfo.UserType	getUserType() Returns the type of phone user.
boolean	isSpeaking() Returns whether the user is currently active speaker in the conference
boolean	isVideo() Optional attribute indicating if the phone user is a video end-point.
void	setCustomOption(java.lang.String optionName, java.lang.String value) Sets custom user options.
void	setOption(UserOption optionName, java.lang.String value) Sets user options.
void	setPhoneNumber(java.lang.String phoneNumber) Sets the user's phone number.
void	setSpeaking(boolean isSpeaking) Specifies whether the user is currently active speaker in the conference
void	setSubconferenceId(java.lang.String subconferenceId) Sets the subconference the phone user is in, when audio breakouts are in use.
void	setTelephonyToken(java.lang.String telephonyToken) Sets the user's telephony token, which is generated and displayed in the meeting UI by Connect Pro.
void	setTelephonyUserId(java.lang.String telephonyUserId) Sets the user's telephony identifier, which is generated by the adaptor.
void	setUserType(TelephonyUserInfo.UserType userType) Sets the type of phone user.
void	setVideo(boolean isVideo) Optional attribute indicating if the phone user is a video end-point.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TelephonyUserInfo

public TelephonyUserInfo(java.lang.String telephonyUserId)

Single argument Constructor. Default constructor is not allowed to prevent errors.

Parameters:

telephonyUserId - User's telephony identifier generated by the adaptor. Can't be null or empty.

TelephonyUserInfo

public TelephonyUserInfo(java.lang.String telephonyUserId,
                         java.lang.String phoneNumber,
                         java.lang.String telephonyToken,
                         java.lang.String subconferenceId,
                         TelephonyUserInfo.UserType userType,
                         boolean isSpeaking,
                         boolean isVideo)

Constructor with all information except option. Convenient for passing a lot of information in a single call.

Parameters:

telephonyUserId - User's telephony identifier generated by the adaptor. Can't be null or empty.

phoneNumber - User's phone number. E.164 number format is recommended but adaptor/bridge needs to support it.

telephonyToken - User's telephony token. Generated and displayed in meeting UI by Connect Pro. Passed on by adaptor when input by the user using DTMF commands.

subconferenceId - The subconference the user is in.

userType - Type of phone user. Generally determines user's role in the conference.

isSpeaking - Whether the user is currently active speaker in the conference.

isVideo - Optional attribute indicating if the phone user is a video end-point. Connect Pro support is limited, simply displaying a video icon for video endpoints.

Method Detail

getCustomOptionNames

public java.lang.String[] getCustomOptionNames()

Returns custom user option names. Useful in iterating over currently set custom options.

getCustomOption

public java.lang.String getCustomOption(java.lang.String optionName)

Returns custom user options.

getOption

public java.lang.String getOption(UserOption optionName)

Returns user options.

getPhoneNumber

public java.lang.String getPhoneNumber()

Returns the user's phone number. E.164 number format is recommended but adaptor/bridge needs to support it.

getTelephonyToken

public java.lang.String getTelephonyToken()

Returns the user's telephony token. Generated and displayed in meeting UI by Connect Pro. Passed on by adaptor when input by the user using DTMF commands

getTelephonyUserId

public java.lang.String getTelephonyUserId()

Returns the user's telephony identifier, which is generated by the adaptor

getUserType

public TelephonyUserInfo.UserType getUserType()

Returns the type of phone user. Generally determines user's role in the conference

isSpeaking

public boolean isSpeaking()

Returns whether the user is currently active speaker in the conference

setCustomOption

public void setCustomOption(java.lang.String optionName,
                            java.lang.String value)

Sets custom user options.

setOption

public void setOption(UserOption optionName,
                      java.lang.String value)

Sets user options.

setPhoneNumber

public void setPhoneNumber(java.lang.String phoneNumber)

Sets the user's phone number. It is recommended to use E.164 number format

setSpeaking

public void setSpeaking(boolean isSpeaking)

Specifies whether the user is currently active speaker in the conference

setTelephonyToken

public void setTelephonyToken(java.lang.String telephonyToken)

Sets the user's telephony token, which is generated and displayed in the meeting UI by Connect Pro. Passed on by adaptor when input by the user using DTMF commands

setTelephonyUserId

public void setTelephonyUserId(java.lang.String telephonyUserId)

Sets the user's telephony identifier, which is generated by the adaptor.

setUserType

public void setUserType(TelephonyUserInfo.UserType userType)

Sets the type of phone user. Generally determines user's role in the conference.

isVideo

public boolean isVideo()

Optional attribute indicating if the phone user is a video end-point. Connect Pro video support is limited, simply displaying a video icon for video endpoints.

setVideo

public void setVideo(boolean isVideo)

Optional attribute indicating if the phone user is a video end-point. Connect Pro video support is limited, simply displaying a video icon for video endpoints

getSubconferenceId

public java.lang.String getSubconferenceId()

Returns the subconference the phone user is in, when audio breakouts are in use.

setSubconferenceId

public void setSubconferenceId(java.lang.String subconferenceId)

Sets the subconference the phone user is in, when audio breakouts are in use.