rocks.xmpp.extensions.muc.model

Class RequestVoice

java.lang.Object

rocks.xmpp.extensions.muc.model.RequestVoice

public final class RequestVoice
extends Object

Represents a standardized DataForm with form type http://jabber.org/protocol/muc#request, which can be used to request voice in a MUC room.

Usage

To wrap an existing DataForm to retrieve standard data from it, use:

 
 RequestVoice requestVoice = new RequestVoice(dataForm);
 
 

To build a form:

 
 RequestVoice requestVoice = RequestVoice.builder()
     .jid(Jid.of("hag66@shakespeare.lit/pda"))
     .role(Role.PARTICIPANT)
     .roomNick("thirdwitch")
     .allowRequest(true)
     .build();
 
 

See Also:

7.13 Requesting Voice, 15.5.2 muc#request FORM_TYPE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestVoice.Builder A builder to build a request voice form.

Constructor Summary

Constructors

Constructor and Description
RequestVoice(DataForm dataForm) Creates the request voice form.

Method Summary

Modifier and Type	Method and Description
static RequestVoice.Builder	builder() Creates the builder to build a form.
DataForm	getDataForm() Gets the underlying data form.
Jid	getJid() Gets the JID.
Role	getRole() Gets the requested role.
String	getRoomNick() Gets the room nick.
boolean	isRequestAllowed() Indicates, whether the request is approved.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestVoice

public RequestVoice(DataForm dataForm)

Creates the request voice form.

Parameters:

dataForm - The underlying data form.

Method Detail

builder

public static RequestVoice.Builder builder()

Creates the builder to build a form.

Returns:

The builder.

getDataForm

public DataForm getDataForm()

Gets the underlying data form.

Returns:

The underlying data form.

getJid

public Jid getJid()

Gets the JID.

Returns:

The JID.

getRoomNick

public String getRoomNick()

Gets the room nick.

Returns:

The room nick.

getRole

public Role getRole()

Gets the requested role.

Returns:

The requested role.

isRequestAllowed

public boolean isRequestAllowed()

Indicates, whether the request is approved.

Returns:

True, if the request is approved.