Struct bigbluebutton::administration::JoinMeetingRequest

pub struct JoinMeetingRequest {
    pub full_name: Option<String>,
    pub meeting_id: Option<String>,
    pub password: Option<String>,
    pub create_time: Option<String>,
    pub user_id: Option<String>,
    pub web_voice_conf: Option<String>,
    pub config_token: Option<String>,
    pub default_layout: Option<u64>,
    pub avatar_url: Option<String>,
    pub client_url: Option<bool>,
    pub join_via_html5: Option<u64>,
    pub guest: Option<bool>,
    // some fields omitted
}

Joins a user to the meeting specified in the meetingID parameter.

Fields

full_name: Option<String>

The full name that is to be used to identify this user to other conference attendees.

meeting_id: Option<String>

The meeting ID that identifies the meeting you are attempting to join.

password: Option<String>

The password that this attendee is using. If the moderator password is supplied, he will be given moderator status (and the same for attendee password, etc)

create_time: Option<String>

Third-party apps using the API can now pass createTime parameter (which was created in the create call), BigBlueButton will ensure it matches the ‘createTime’ for the session. If they differ, BigBlueButton will not proceed with the join request. This prevents a user from reusing their join URL for a subsequent session with the same meetingID.

user_id: Option<String>

An identifier for this user that will help your application to identify which person this is. This user ID will be returned for this user in the getMeetingInfo API call so that you can check

web_voice_conf: Option<String>

If you want to pass in a custom voice-extension when a user joins the voice conference using voip. This is useful if you want to collect more info in you Call Detail Records about the user joining the conference. You need to modify your /etc/asterisk/bbb-extensions.conf to handle this new extensions.

config_token: Option<String>

The token returned by a setConfigXML API call. This causes the BigBlueButton client to load the config.xml associated with the token (not the default config.xml)

default_layout: Option<u64>

The layout name to be loaded first when the application is loaded.

avatar_url: Option<String>

The link for the user’s avatar to be displayed when displayAvatar in config.xml is set to true (not yet implemented in the HTML5 client, see #8566.

client_url: Option<bool>

Some third party apps what to display their own custom client. These apps can pass the URL containing the custom client and when redirect is not set to false, the browser will get redirected to the value of clientURL.

join_via_html5: Option<u64>

Set to “true” to force the HTML5 client to load for the user.

guest: Option<bool>

Set to “true” to indicate that the user is a guest, otherwise do NOT send this parameter.

Implementations

impl JoinMeetingRequest

pub fn new() -> Self

creates new JoinMeetingRequest

Trait Implementations

impl Debug for JoinMeetingRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JoinMeetingRequest

fn default() -> JoinMeetingRequest

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for JoinMeetingRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Execute<JoinMeetingRequest, JoinMeetingResponse> for Bigbluebutton

fn execute<'life0, 'life1, 'async_trait>(
    &'life0 self,
    request: &'life1 JoinMeetingRequest
) -> Pin<Box<dyn Future<Output = Result<JoinMeetingResponse, BBBError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

trait function to execute requests

impl Serialize for JoinMeetingRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.