org.exoplatform.moxtra.client

Class MoxtraMeet

java.lang.Object

org.exoplatform.moxtra.client.MoxtraBinder

org.exoplatform.moxtra.client.MoxtraMeet

public class MoxtraMeet
extends MoxtraBinder

Moxtra meet as described in their REST API.
Created by The eXo Platform SAS

Version:

$Id: MoxtraMeet.java 00000 Feb 27, 2015 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected String	agenda
protected Boolean	autoRecording
protected Date	endTime
static String	SESSION_DELETED
static String	SESSION_ENDED
static String	SESSION_SCHEDULED
static int	SESSION_START_BEFORE_MINUTES Maximum, and default, time for starting a meet before its scheduled start time from Moxtra API.
static String	SESSION_STARTED
protected String	sessionId Optional.
protected String	sessionKey Session key it is a meet ID also.
protected String	startMeetUrl
protected Date	startTime
protected String	status

Fields inherited from class org.exoplatform.moxtra.client.MoxtraBinder

binderId, createdTime, deleted, isNew, name, revision, thumbnailUrl, updatedTime, USER_STATUS_BOARD_INVITED, USER_STATUS_BOARD_MEMBER, USER_TYPE_BOARD_OWNER, USER_TYPE_BOARD_READ_WRITE, users

Constructor Summary

Constructors

Modifier	Constructor and Description
	MoxtraMeet() New meet constructor.
protected	MoxtraMeet(MoxtraMeet otherMeet) Editor constructor.
	MoxtraMeet(String name, String agenda, Date startTime, Date endTime, Boolean autoRecording) Deprecated.
	MoxtraMeet(String binderId, String name, Long revision, Date createdTime, Date updatedTime) Deprecated.
	MoxtraMeet(String sessionKey, String sessionId, String binderId, String name, Long revision, String startMeetUrl, Date createdTime, Date updatedTime) Existing meet constructor (for use with JS API session).
	MoxtraMeet(String sessionKey, String scheduleBinderId, String name, String agenda, Long revision, String startMeetUrl, Date createdTime, Date updatedTime, Date startTime, Date endTime, Boolean autoRecording) Deprecated.
protected	MoxtraMeet(String sessionKey, String sessionId, String binderId, String name, String agenda, Long revision, String startMeetUrl, Date createdTime, Date updatedTime, Date startTime, Date endTime, Boolean autoRecording, String status)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canStart() Check if meet can be started.
protected void	checkTime() Check and align if required the time for start and end to ensure they are in natural order (end after the start).
static MoxtraMeet	create(String sessionKey, String sessionId, String binderId, String name, String agenda, Long revision, String startMeetUrl, Date createdTime, Date updatedTime, Date startTime, Date endTime, Boolean autoRecording, List<MoxtraUser> users) Create meet object from given data.
void	editAgenda(String newAgenda)
void	editAutoRecording(Boolean newAutoRecording)
void	editEndTime(Date newEndTime) Set new end time.
MoxtraMeet	editor() Return an editor instance for this binder.
void	editStartTime(Date newStartTime) Set new start time.
String	getAgenda()
Boolean	getAutoRecording()
Date	getEndTime() Meet's end time as scheduled.
MoxtraUser	getHostUser() User that hosts this meet.
String	getSessionId()
String	getSessionKey()
String	getStartMeetUrl()
Date	getStartTime() Meet's start time as scheduled.
String	getStatus()
String	getVideoPath()
String	getVideoWorkspace()
boolean	hasAgendaChanged()
boolean	hasAutoRecordingChanged()
boolean	hasEndTimeChanged()
boolean	hasStartTimeChanged()
boolean	hasUser(MoxtraUser user) Tells if given user is invited in this meet.
boolean	isAutoRecording() Tells if auto-recording enabled for the meet.
boolean	isDeleted() Check if meet was deleted remotely in Moxtra.
boolean	isEnded() Check if meet already had started and ended in Moxtra.
boolean	isExpired() Check if scheduled meet not already expired its planned end time.
boolean	isScheduled() Check if meet scheduled in Moxtra.
boolean	isStarted()
protected void	setAgenda(String agenda)
protected void	setAutoRecording(Boolean autoRecording)
protected void	setEndTime(Date endTime)
protected void	setHostUser(MoxtraUser hostUser)
protected void	setSessionId(String sessionId)
protected void	setSessionKey(String sessionKey)
protected void	setStartMeetUrl(String startMeetUrl)
protected void	setStartTime(Date startTime)
protected void	setStatus(String status)
void	setVideoPath(String videoPath)
void	setVideoWorkspace(String videoWorkspace)
String	toString()

Methods inherited from class org.exoplatform.moxtra.client.MoxtraBinder

addUser, delete, editName, getAddedUsers, getBinderId, getCreatedTime, getName, getRemovedUsers, getRevision, getThumbnailUrl, getUpdatedTime, getUsers, hasDeleted, hasNameChanged, hasUsersAdded, hasUsersRemoved, isEditor, isNew, removeUser, setBinderId, setCreatedTime, setName, setRevision, setThumbnailUrl, setUpdatedTime, setUsers, undelete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SESSION_SCHEDULED

public static final String SESSION_SCHEDULED

SESSION_STARTED

public static final String SESSION_STARTED

SESSION_ENDED

public static final String SESSION_ENDED

SESSION_DELETED

public static final String SESSION_DELETED

SESSION_START_BEFORE_MINUTES

public static final int SESSION_START_BEFORE_MINUTES

Maximum, and default, time for starting a meet before its scheduled start time from Moxtra API.

See Also:

Constant Field Values

sessionKey

protected String sessionKey

Session key it is a meet ID also. Can be used to build a start URL https://www.moxtra.com/{session_key}.

sessionId

protected String sessionId

Optional. For use with JS API calls when inviting users via /meets/inviteuser REST service.

agenda

protected String agenda

startMeetUrl

protected String startMeetUrl

autoRecording

protected Boolean autoRecording

startTime

protected Date startTime

endTime

protected Date endTime

status

protected String status

Constructor Detail

MoxtraMeet

protected MoxtraMeet(String sessionKey,
          String sessionId,
          String binderId,
          String name,
          String agenda,
          Long revision,
          String startMeetUrl,
          Date createdTime,
          Date updatedTime,
          Date startTime,
          Date endTime,
          Boolean autoRecording,
          String status)

MoxtraMeet

public MoxtraMeet(String sessionKey,
          String sessionId,
          String binderId,
          String name,
          Long revision,
          String startMeetUrl,
          Date createdTime,
          Date updatedTime)

Existing meet constructor (for use with JS API session).

Parameters:

sessionKey -

sessionId -

scheduleBinderId -

name -

revision -

startMeetUrl -

createdTime -

updatedTime -

MoxtraMeet

@Deprecated
public MoxtraMeet(String binderId,
                     String name,
                     Long revision,
                     Date createdTime,
                     Date updatedTime)

Deprecated.

Existing meet constructor (for reading from Binder REST API).

Parameters:

binderId -

name -

revision -

createdTime -

updatedTime -

MoxtraMeet

@Deprecated
public MoxtraMeet(String sessionKey,
                     String scheduleBinderId,
                     String name,
                     String agenda,
                     Long revision,
                     String startMeetUrl,
                     Date createdTime,
                     Date updatedTime,
                     Date startTime,
                     Date endTime,
                     Boolean autoRecording)

Deprecated.

Existing meet constructor (for returning from Schedule Meet REST API).

Parameters:

sessionKey -

scheduleBinderId -

name -

agenda -

revision -

startMeetUrl -

createdTime -

updatedTime -

startTime -

endTime -

autoRecording -

MoxtraMeet

public MoxtraMeet()

New meet constructor. For creating a new meet in Moxtra.

MoxtraMeet

@Deprecated
public MoxtraMeet(String name,
                     String agenda,
                     Date startTime,
                     Date endTime,
                     Boolean autoRecording)

Deprecated.

New meet constructor (for creation in REST API).

Parameters:

name -

agenda -

startTime -

endTime -

autoRecording -

MoxtraMeet

protected MoxtraMeet(MoxtraMeet otherMeet)

Editor constructor.

Parameters:

otherMeet -

Method Detail

create

public static MoxtraMeet create(String sessionKey,
                String sessionId,
                String binderId,
                String name,
                String agenda,
                Long revision,
                String startMeetUrl,
                Date createdTime,
                Date updatedTime,
                Date startTime,
                Date endTime,
                Boolean autoRecording,
                List<MoxtraUser> users)

Create meet object from given data. Use this method for deserealization from local storage.

Parameters:

sessionKey -

sessionId -

binderId -

name -

agenda -

revision -

startMeetUrl -

createdTime -

updatedTime -

startTime -

endTime -

autoRecording -

Returns:

toString

public String toString()

Overrides:

toString in class MoxtraBinder

editor

public MoxtraMeet editor()

Return an editor instance for this binder. If invoke this method on already editor instance then it will return itself. If invoke several times, the same editor instance will be returned. Editor exists as a singleton for a particular binder.

Overrides:

editor in class MoxtraBinder

Returns:

MoxtraBinder edit instance

getHostUser

public MoxtraUser getHostUser()
                       throws MoxtraException

User that hosts this meet.

Returns:

MoxtraUser

Throws:

MoxtraException - when owner cannot not defined

hasUser

public boolean hasUser(MoxtraUser user)

Tells if given user is invited in this meet.

Parameters:

user - MoxtraUser

Returns:

boolean true if user invited in this meet, false otherwise

getSessionKey

public String getSessionKey()

Returns:

the sessionKey

getSessionId

public String getSessionId()

Returns:

the sessionId

getAgenda

public String getAgenda()

Returns:

the agenda

getStartMeetUrl

public String getStartMeetUrl()

Returns:

the startMeetUrl

getStatus

public String getStatus()

Returns:

the meet status in Moxtra

isStarted

public boolean isStarted()

isEnded

public boolean isEnded()

Check if meet already had started and ended in Moxtra.

Returns:

true if meet ended in Moxtra, false otherwise

isScheduled

public boolean isScheduled()

Check if meet scheduled in Moxtra.

Returns:

true if meet scheduled in Moxtra, false otherwise

isDeleted

public boolean isDeleted()

Check if meet was deleted remotely in Moxtra.
Don't confuse this method with MoxtraBinder.hasDeleted() which describes local state of this meet editor instance before the actual deletion in Moxtra.

Returns:

true if meet removed in Moxtra, false otherwise

isExpired

public boolean isExpired()

Check if scheduled meet not already expired its planned end time.

Returns:

true if end time already gone, false otherwise

canStart

public boolean canStart()

Check if meet can be started. Meet can be started when it is in scheduled state and its start date is near current time (before 30 min if other not defined exactly for this meet). If meet wasn't started at planned time it still may be started during the planned day if other will not be defined by Moxtra API.
Note that this method doesn't cover a case for host user: he/she can start a meet in any time before the scheduled time.

Returns:

true if meet can be started, false otherwise

getStartTime

public Date getStartTime()

Meet's start time as scheduled. If start time was not defined then it will be set to a next minute.

Returns:

the startTime

getEndTime

public Date getEndTime()

Meet's end time as scheduled.

Returns:

the endTime

getAutoRecording

public Boolean getAutoRecording()

Returns:

Boolean the auto-recording flag for the meet, can be null when reading from Moxtra

isAutoRecording

public boolean isAutoRecording()

Tells if auto-recording enabled for the meet.

editAutoRecording

public void editAutoRecording(Boolean newAutoRecording)

Parameters:

newAutoRecording - the new autoRecording

hasAutoRecordingChanged

public boolean hasAutoRecordingChanged()

editStartTime

public void editStartTime(Date newStartTime)

Set new start time.

Parameters:

newStartTime - the startTime to set

hasStartTimeChanged

public boolean hasStartTimeChanged()

editEndTime

public void editEndTime(Date newEndTime)

Set new end time.

Parameters:

newEndTime - the endTime to set

hasEndTimeChanged

public boolean hasEndTimeChanged()

editAgenda

public void editAgenda(String newAgenda)

Parameters:

agenda - the agenda to set

hasAgendaChanged

public boolean hasAgendaChanged()

setVideoWorkspace

public void setVideoWorkspace(String videoWorkspace)

Parameters:

videoWorkspace - the videoWorkspace to set

setVideoPath

public void setVideoPath(String videoPath)

Parameters:

videoPath - the videoPath to set

getVideoWorkspace

public String getVideoWorkspace()

Returns:

the videoWorkspace, can be null

getVideoPath

public String getVideoPath()

Returns:

the videoPath, can be null

setHostUser

protected void setHostUser(MoxtraUser hostUser)

Parameters:

hostUser - the hostUser to set

setAutoRecording

protected void setAutoRecording(Boolean autoRecording)

Parameters:

autoRecording - the autoRecording to set

setStartTime

protected void setStartTime(Date startTime)

Parameters:

startTime - the startTime to set

setEndTime

protected void setEndTime(Date endTime)

Parameters:

endTime - the endTime to set

setAgenda

protected void setAgenda(String agenda)

Parameters:

agenda - the agenda to set

setSessionKey

protected void setSessionKey(String sessionKey)

Parameters:

sessionKey - the sessionKey to set

setSessionId

protected void setSessionId(String sessionId)

Parameters:

sessionId - the sessionId to set

setStartMeetUrl

protected void setStartMeetUrl(String startMeetUrl)

Parameters:

startMeetUrl - the startMeetUrl to set

setStatus

protected void setStatus(String status)

Parameters:

status - the status to set

checkTime

protected void checkTime()

Check and align if required the time for start and end to ensure they are in natural order (end after the start).