TANDBERG 3.0 User Manual

Page 23

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

19

Field

Type

Comments
layout is enabled.

newParticipantsCustomLayout Boolean

True if new participants will use the
conference custom layout.

private

Boolean

True if this conference is a private
conference.

chairControl

String

The chair control setting for this conference.
See the chairControl description in
conference.create for an explanation of the
values this parameter can take.

The following timing fields will be present for scheduled conferences only
startTime

dateTime.iso8601 The time at which the conference started at or

will start at.

durationSeconds

Integer

How long each repeating instance of the
conference should last for. If absent, the
conference is permanent.

repetition(optional) String One

of

none

,

daily

,

weekly

,

everyTwoWeeks

or

monthly.

weekDay(optional)

String

Present if repetition is

monthly

. One of

monday

,

tuesday

,

wednesday

,

thursday

,

friday

,

saturday

or

sunday

.

whichWeek (optional)

String

Present if repetition is

monthly

. One of:

first

(the first X of the month, where X is

the day specified by weekday),

second

,

third

,

fourth

, or

last

(i.e. last X of the

month)

weekDays (optional)

String

A comma separated string of weekdays (i.e.
any of

monday

,

tuesday

,

wednesday

,

thursday

,

friday

,

saturday

or

sunday

),

e.g.

monday,wednesday,friday

.

This field is present when repetition is

weekly

or

everyTwoWeeks

.

terminationType(optional) String

One

of:

noTermination

,

afterNRepeats

or

endOnGivenDate

.

terminationDate(optional) dateTime.iso8601 If terminationType is

endOnGivenDay

, this is

the day that the conference repetition will end
on.

The following timing values will be present for active conferences only
activeStartTime dateTime.iso8601
activeEndTime dateTime.iso8601

If the conference is currently active, these
fields show the time span of the current
activation. If the conference is permanent
then “activeEndTime” will be absent.

activeConferenceId

string

A unique ID for the active instance of this

conference; this conference will have this ID
even if, for example, the conference is
renamed while active, but each scheduled
instance of this conference will have a
different activeConferenceId.

Advertising