[−][src]Struct bigbluebutton::administration::CreateMeetingRequest
Creates a BigBlueButton meeting.
Fields
name: Option<String>
A name for the meeting.
meeting_id: Option<String>
A meeting ID that can be used to identify this meeting by the 3rd-party application.
attandee_pw: Option<String>
The password that the join URL can later provide as its password parameter to indicate the user will join as a viewer. If no attendeePW is provided, the create call will return a randomly generated attendeePW password for the meeting.
moderator_pw: Option<String>
The password that will join URL can later provide as its password parameter to indicate the user will as a moderator. if no moderatorPW is provided, create will return a randomly generated moderatorPW password for the meeting.
welcome: Option<String>
A welcome message that gets displayed on the chat window when the participant joins.
dial_number: Option<String>
The dial access number that participants can call in using regular phone.
voice_bridge: Option<String>
Voice conference number for the FreeSWITCH voice conference associated with this meeting.
max_participants: Option<u64>
Set the maximum number of users allowed to joined the conference at the same time.
logout_url: Option<String>
The URL that the BigBlueButton client will go to after users click the OK button on the ‘You have been logged out message’.
record: Option<bool>
Setting ‘record=true’ instructs the BigBlueButton server to record the media and events in the session for later playback. The default is false.
duration: Option<u64>
The maximum length (in minutes) for the meeting.
is_breakout: Option<bool>
Must be set to true to create a breakout room.
parent_meeting_id: Option<String>
Must be provided when creating a breakout room, the parent room must be running.
sequence: Option<u64>
The sequence number of the breakout room.
free_join: Option<bool>
If set to true, the client will give the user the choice to choose the breakout rooms he wants to join.
meta: Option<String>
You can pass one or more metadata values when creating a meeting. These will be stored by BigBlueButton can be retrieved later via the getMeetingInfo and getRecordings calls.
moderator_only_message: Option<String>
Display a message to all moderators in the public chat.
auto_start_recording: Option<bool>
Whether to automatically start recording when first user joins (default false).
allow_start_stop_recording: Option<bool>
Allow the user to start/stop recording. (default true)
webcams_only_for_moderator: Option<bool>
Setting webcamsOnlyForModerator=true will cause all webcams shared by viewers during this meeting to only appear for moderators
logo: Option<String>
Setting logo=http://www.example.com/my-custom-logo.png will replace the default logo in the Flash client.
Will set the banner text in the client.
Will set the banner background color in the client. The required format is color hex #FFFFFF.
copyright: Option<String>
Setting copyright=My custom copyright will replace the default copyright on the footer of the Flash client.
mute_on_start: Option<bool>
Setting muteOnStart=true will mute all users when the meeting starts.
allow_mods_to_unmute_users: Option<bool>
Default allowModsToUnmuteUsers=false. Setting to allowModsToUnmuteUsers=true will allow moderators to unmute other users in the meeting.
lock_settings_disable_cam: Option<bool>
Default lockSettingsDisableCam=false. Setting lockSettingsDisableCam=true will prevent users from sharing their camera in the meeting.
lock_settings_disable_mic: Option<bool>
Default lockSettingsDisableMic=false. Setting to lockSettingsDisableMic=true will only allow user to join listen only.
lock_settings_disable_private_chat: Option<bool>
Default lockSettingsDisablePrivateChat=false. Setting to lockSettingsDisablePrivateChat=true will disable private chats in the meeting.
lock_settings_disable_public_chat: Option<bool>
Default lockSettingsDisablePublicChat=false. Setting to lockSettingsDisablePublicChat=true will disable public chat in the meeting
lock_settings_disable_note: Option<bool>
Default lockSettingsDisableNote=false. Setting to lockSettingsDisableNote=true will disable notes in the meeting.
lock_settings_locked_layout: Option<bool>
Default lockSettingsLockedLayout=false. Setting to lockSettingsLockedLayout=true will lock the layout in the meeting.
lock_settings_lock_on_join: Option<bool>
Default lockSettingsLockOnJoin=true. Setting to lockSettingsLockOnJoin=false will not apply lock setting to users when they join.
lock_settings_lock_on_join_configurable: Option<bool>
Default lockSettingsLockOnJoinConfigurable=false. Setting to lockSettingsLockOnJoinConfigurable=true will allow applying of lockSettingsLockOnJoin param.
guest_policy: Option<String>
Default guestPolicy=ALWAYS_ACCEPT. Will set the guest policy for the meeting. The guest policy determines whether or not users who send a join request with guest=true will be allowed to join the meeting. Possible values are ALWAYS_ACCEPT, ALWAYS_DENY, and ASK_MODERATOR.
Implementations
impl CreateMeetingRequest
[src]
pub fn new() -> Self
[src]
Creates new CreateMeetingRequest
use bigbluebutton::administration::CreateMeetingRequest; let bbb = Bigbluebutton::new("https://server.com/bigbluebutton/", "secret"); let mut request = CreateMeetingRequest::new(); request.meeting_id = Some("12".to_string()); bbb.execute(&request);
Trait Implementations
impl Debug for CreateMeetingRequest
[src]
impl Default for CreateMeetingRequest
[src]
fn default() -> CreateMeetingRequest
[src]
impl<'de> Deserialize<'de> for CreateMeetingRequest
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Execute<CreateMeetingRequest, CreateMeetingResponse> for Bigbluebutton
[src]
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
request: &'life1 CreateMeetingRequest
) -> Pin<Box<dyn Future<Output = Result<CreateMeetingResponse, BBBError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
[src]
&'life0 self,
request: &'life1 CreateMeetingRequest
) -> Pin<Box<dyn Future<Output = Result<CreateMeetingResponse, BBBError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
impl Serialize for CreateMeetingRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for CreateMeetingRequest
impl Send for CreateMeetingRequest
impl Sync for CreateMeetingRequest
impl Unpin for CreateMeetingRequest
impl UnwindSafe for CreateMeetingRequest
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,