Documentation
¶
Index ¶
- type AttendeePrivileges
- type AudioConnectionOptions
- type BreakoutSession
- type CallInNumber
- type Client
- func (c *Client) Create(meeting *Meeting) (*Meeting, error)
- func (c *Client) Delete(meetingID string) error
- func (c *Client) Get(meetingID string) (*Meeting, error)
- func (c *Client) GetParticipant(participantID string, meetingID string) (*Participant, error)
- func (c *Client) List(options *ListOptions) (*MeetingsPage, error)
- func (c *Client) ListParticipants(options *ParticipantListOptions) (*ParticipantsPage, error)
- func (c *Client) Patch(meetingID string, patch interface{}) (*Meeting, error)
- func (c *Client) Update(meetingID string, meeting *Meeting) (*Meeting, error)
- type Config
- type CustomQuestion
- type Interpreter
- type Invitee
- type ListOptions
- type LiveStream
- type Meeting
- type MeetingOptions
- type MeetingsPage
- type Participant
- type ParticipantDevice
- type ParticipantListOptions
- type ParticipantsPage
- type Registration
- type SimultaneousInterpretation
- type Telephony
- type TelephonyLink
- type TelephonyLinks
- type TrackingCode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttendeePrivileges ¶ added in v2.0.12
type AttendeePrivileges struct {
EnabledAnnotate bool `json:"enabledAnnotate,omitempty"`
EnabledChatHost bool `json:"enabledChatHost,omitempty"`
EnabledChatOtherParticipants bool `json:"enabledChatOtherParticipants,omitempty"`
EnabledChatPresenter bool `json:"enabledChatPresenter,omitempty"`
EnabledContactOperatorPrivately bool `json:"enabledContactOperatorPrivately,omitempty"`
EnabledPrintDocument bool `json:"enabledPrintDocument,omitempty"`
EnabledRemoteControl bool `json:"enabledRemoteControl,omitempty"`
EnabledSaveDocument bool `json:"enabledSaveDocument,omitempty"`
EnabledViewAnyDocument bool `json:"enabledViewAnyDocument,omitempty"`
EnabledViewAnyPage bool `json:"enabledViewAnyPage,omitempty"`
EnabledViewParticipantList bool `json:"enabledViewParticipantList,omitempty"`
EnabledViewThumbnails bool `json:"enabledViewThumbnails,omitempty"`
}
AttendeePrivileges contains attendee privilege settings
type AudioConnectionOptions ¶
type AudioConnectionOptions struct {
AudioConnectionType string `json:"audioConnectionType,omitempty"`
EnabledTollFreeCallIn bool `json:"enabledTollFreeCallIn,omitempty"`
EnabledGlobalCallIn bool `json:"enabledGlobalCallIn,omitempty"`
EnabledAudienceCallBack bool `json:"enabledAudienceCallBack,omitempty"`
EntryAndExitTone string `json:"entryAndExitTone,omitempty"`
AllowHostToUnmuteParticipants bool `json:"allowHostToUnmuteParticipants,omitempty"`
AllowAttendeeToUnmuteSelf bool `json:"allowAttendeeToUnmuteSelf,omitempty"`
MuteAttendeeUponEntry bool `json:"muteAttendeeUponEntry,omitempty"`
}
AudioConnectionOptions contains audio connection settings
type BreakoutSession ¶
type BreakoutSession struct {
Name string `json:"name,omitempty"`
Users []string `json:"users,omitempty"`
}
BreakoutSession represents a meeting breakout session
type CallInNumber ¶
type CallInNumber struct {
Label string `json:"label,omitempty"`
CallInNumber string `json:"callInNumber,omitempty"`
TollType string `json:"tollType,omitempty"`
}
CallInNumber represents a phone number for dialing into a meeting
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the meetings API client
func (*Client) GetParticipant ¶
func (c *Client) GetParticipant(participantID string, meetingID string) (*Participant, error)
GetParticipant returns details for a specific meeting participant.
func (*Client) List ¶
func (c *Client) List(options *ListOptions) (*MeetingsPage, error)
List returns a list of meetings. Note: The Webex API requires meetingType to be set when state is used as a filter. Without meetingType specified, the API returns meeting series (recurring definitions) rather than actual meeting instances. Use meetingType="meeting" with state="ended" and a from/to date range to list past meeting instances.
func (*Client) ListParticipants ¶
func (c *Client) ListParticipants(options *ParticipantListOptions) (*ParticipantsPage, error)
ListParticipants returns a list of participants for a meeting instance. Requires a meetingId that is a meeting instance ID (ended meetings).
type Config ¶
type Config struct {
}
Config holds the configuration for the Meetings plugin
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns the default configuration for the Meetings plugin
type CustomQuestion ¶
type CustomQuestion struct {
ID int `json:"id,omitempty"`
Question string `json:"question,omitempty"`
Type string `json:"type,omitempty"`
Required bool `json:"required,omitempty"`
Options []string `json:"options,omitempty"`
}
CustomQuestion represents a custom registration question
type Interpreter ¶
type Interpreter struct {
ID string `json:"id,omitempty"`
Email string `json:"email,omitempty"`
DisplayName string `json:"displayName,omitempty"`
LanguageCode1 string `json:"languageCode1,omitempty"`
LanguageCode2 string `json:"languageCode2,omitempty"`
}
Interpreter represents a meeting interpreter
type Invitee ¶
type Invitee struct {
ID string `json:"id,omitempty"`
Email string `json:"email,omitempty"`
DisplayName string `json:"displayName,omitempty"`
CoHost bool `json:"coHost,omitempty"`
MeetingID string `json:"meetingId,omitempty"`
Panelist bool `json:"panelist,omitempty"`
}
Invitee represents a meeting invitee
type ListOptions ¶
type ListOptions struct {
MeetingNumber string `url:"meetingNumber,omitempty"`
MeetingType string `url:"meetingType,omitempty"`
State string `url:"state,omitempty"`
ScheduledType string `url:"scheduledType,omitempty"`
HostEmail string `url:"hostEmail,omitempty"`
SiteURL string `url:"siteUrl,omitempty"`
IntegrationTag string `url:"integrationTag,omitempty"`
From string `url:"from,omitempty"`
To string `url:"to,omitempty"`
Max int `url:"max,omitempty"`
Current bool `url:"current,omitempty"`
}
ListOptions contains the options for listing meetings
type LiveStream ¶ added in v2.0.12
type LiveStream struct {
Destination string `json:"destination,omitempty"`
Resolution string `json:"resolution,omitempty"`
RtmpUrl string `json:"rtmpUrl,omitempty"`
StreamUrl string `json:"streamUrl,omitempty"`
AllowChangeLayoutInMeeting bool `json:"allowChangeLayoutInMeeting,omitempty"`
FollowStageLayoutWhenSynced bool `json:"followStageLayoutWhenSynced,omitempty"`
}
LiveStream contains live streaming configuration
type Meeting ¶
type Meeting struct {
ID string `json:"id,omitempty"`
MeetingSeriesID string `json:"meetingSeriesId,omitempty"`
ScheduledMeetingID string `json:"scheduledMeetingId,omitempty"`
Title string `json:"title,omitempty"`
Agenda string `json:"agenda,omitempty"`
Password string `json:"password,omitempty"`
Start string `json:"start,omitempty"`
End string `json:"end,omitempty"`
Timezone string `json:"timezone,omitempty"`
Recurrence string `json:"recurrence,omitempty"`
EnabledAutoRecordMeeting bool `json:"enabledAutoRecordMeeting,omitempty"`
AllowAnyUserToBeCoHost bool `json:"allowAnyUserToBeCoHost,omitempty"`
EnabledJoinBeforeHost bool `json:"enabledJoinBeforeHost,omitempty"`
EnableConnectAudioBeforeHost bool `json:"enableConnectAudioBeforeHost,omitempty"`
JoinBeforeHostMinutes int `json:"joinBeforeHostMinutes,omitempty"`
ExcludePassword bool `json:"excludePassword,omitempty"`
PublicMeeting bool `json:"publicMeeting,omitempty"`
MeetingType string `json:"meetingType,omitempty"`
State string `json:"state,omitempty"`
ScheduledType string `json:"scheduledType,omitempty"`
HostUserID string `json:"hostUserId,omitempty"`
HostDisplayName string `json:"hostDisplayName,omitempty"`
HostEmail string `json:"hostEmail,omitempty"`
SipAddress string `json:"sipAddress,omitempty"`
WebLink string `json:"webLink,omitempty"`
MeetingNumber string `json:"meetingNumber,omitempty"`
PhoneAndVideoSystemPassword string `json:"phoneAndVideoSystemPassword,omitempty"`
SiteURL string `json:"siteUrl,omitempty"`
EnabledBreakoutSessions bool `json:"enabledBreakoutSessions,omitempty"`
Invitees []Invitee `json:"invitees,omitempty"`
IntegrationTags []string `json:"integrationTags,omitempty"`
Telephony *Telephony `json:"telephony,omitempty"`
Registration *Registration `json:"registration,omitempty"`
SimultaneousInterpretation *SimultaneousInterpretation `json:"simultaneousInterpretation,omitempty"`
BreakoutSessions []BreakoutSession `json:"breakoutSessions,omitempty"`
AudioConnectionOptions *AudioConnectionOptions `json:"audioConnectionOptions,omitempty"`
HasChat bool `json:"hasChat,omitempty"`
HasRecording bool `json:"hasRecording,omitempty"`
HasTranscription bool `json:"hasTranscription,omitempty"`
HasSummary bool `json:"hasSummary,omitempty"`
HasClosedCaption bool `json:"hasClosedCaption,omitempty"`
HasPolls bool `json:"hasPolls,omitempty"`
HasQA bool `json:"hasQA,omitempty"`
HasRegistration bool `json:"hasRegistration,omitempty"`
HasRegistrants bool `json:"hasRegistrants,omitempty"`
Created *time.Time `json:"created,omitempty"`
UnlockedMeetingJoinSecurity string `json:"unlockedMeetingJoinSecurity,omitempty"`
AllowAuthenticatedDevices bool `json:"allowAuthenticatedDevices,omitempty"`
AllowFirstUserToBeCoHost bool `json:"allowFirstUserToBeCoHost,omitempty"`
AttendeeDidJoin bool `json:"attendeeDidJoin,omitempty"`
EnableAutomaticLock bool `json:"enableAutomaticLock,omitempty"`
EnabledAudioWatermark bool `json:"enabledAudioWatermark,omitempty"`
EnabledLiveStream bool `json:"enabledLiveStream,omitempty"`
EnabledVisualWatermark bool `json:"enabledVisualWatermark,omitempty"`
EnabledWebcastView bool `json:"enabledWebcastView,omitempty"`
RequireAttendeeLogin bool `json:"requireAttendeeLogin,omitempty"`
RestrictToInvitees bool `json:"restrictToInvitees,omitempty"`
AutomaticLockMinutes int `json:"automaticLockMinutes,omitempty"`
ReminderTime int `json:"reminderTime,omitempty"`
SessionTypeId int `json:"sessionTypeId,omitempty"`
VisualWatermarkOpacity int `json:"visualWatermarkOpacity,omitempty"`
TrackingCodes []TrackingCode `json:"trackingCodes,omitempty"`
AttendeePrivileges *AttendeePrivileges `json:"attendeePrivileges,omitempty"`
MeetingOptions *MeetingOptions `json:"meetingOptions,omitempty"`
LiveStream *LiveStream `json:"liveStream,omitempty"`
}
Meeting represents a Webex meeting
type MeetingOptions ¶ added in v2.0.12
type MeetingOptions struct {
EnabledChat bool `json:"enabledChat,omitempty"`
EnabledFileTransfer bool `json:"enabledFileTransfer,omitempty"`
EnabledNote bool `json:"enabledNote,omitempty"`
EnabledPolling bool `json:"enabledPolling,omitempty"`
EnabledUCFRichMedia bool `json:"enabledUCFRichMedia,omitempty"`
EnabledVideo bool `json:"enabledVideo,omitempty"`
NoteType string `json:"noteType,omitempty"`
}
MeetingOptions contains meeting option settings
type MeetingsPage ¶
MeetingsPage represents a paginated list of meetings
type Participant ¶
type Participant struct {
ID string `json:"id,omitempty"`
OrgID string `json:"orgId,omitempty"`
Host bool `json:"host,omitempty"`
CoHost bool `json:"coHost,omitempty"`
SpaceModerator bool `json:"spaceModerator,omitempty"`
Email string `json:"email,omitempty"`
DisplayName string `json:"displayName,omitempty"`
Invitee bool `json:"invitee,omitempty"`
Muted bool `json:"muted,omitempty"`
State string `json:"state,omitempty"`
JoinedTime string `json:"joinedTime,omitempty"`
LeftTime string `json:"leftTime,omitempty"`
MeetingID string `json:"meetingId,omitempty"`
HostEmail string `json:"hostEmail,omitempty"`
Devices []ParticipantDevice `json:"devices,omitempty"`
}
Participant represents a meeting participant
type ParticipantDevice ¶
type ParticipantDevice struct {
DeviceType string `json:"deviceType,omitempty"`
JoinedTime string `json:"joinedTime,omitempty"`
LeftTime string `json:"leftTime,omitempty"`
CallType string `json:"callType,omitempty"`
CallInNumber string `json:"callInNumber,omitempty"`
AudioType string `json:"audioType,omitempty"`
}
ParticipantDevice represents a device used by a meeting participant
type ParticipantListOptions ¶
type ParticipantListOptions struct {
MeetingID string `url:"meetingId,omitempty"`
HostEmail string `url:"hostEmail,omitempty"`
Max int `url:"max,omitempty"`
}
ParticipantListOptions contains the options for listing meeting participants
type ParticipantsPage ¶
type ParticipantsPage struct {
Items []Participant `json:"items"`
*webexsdk.Page
}
ParticipantsPage represents a paginated list of meeting participants
type Registration ¶
type Registration struct {
AutoAcceptRequest bool `json:"autoAcceptRequest,omitempty"`
RequireFirstName bool `json:"requireFirstName,omitempty"`
RequireLastName bool `json:"requireLastName,omitempty"`
RequireEmail bool `json:"requireEmail,omitempty"`
RequireJobTitle bool `json:"requireJobTitle,omitempty"`
RequireCompanyName bool `json:"requireCompanyName,omitempty"`
RequireAddress1 bool `json:"requireAddress1,omitempty"`
RequireAddress2 bool `json:"requireAddress2,omitempty"`
RequireCity bool `json:"requireCity,omitempty"`
RequireState bool `json:"requireState,omitempty"`
RequireZipCode bool `json:"requireZipCode,omitempty"`
RequireCountry bool `json:"requireCountryRegion,omitempty"`
RequirePhone bool `json:"requireWorkPhone,omitempty"`
RequireFax bool `json:"requireFax,omitempty"`
MaxRegisterNum int `json:"maxRegisterNum,omitempty"`
CustomQuestions []CustomQuestion `json:"customizedQuestions,omitempty"`
}
Registration contains meeting registration settings
type SimultaneousInterpretation ¶
type SimultaneousInterpretation struct {
Enabled bool `json:"enabled,omitempty"`
Interpreters []Interpreter `json:"interpreters,omitempty"`
}
SimultaneousInterpretation contains interpretation settings
type Telephony ¶
type Telephony struct {
AccessCode string `json:"accessCode,omitempty"`
CallInNumbers []CallInNumber `json:"callInNumbers,omitempty"`
Links *TelephonyLinks `json:"links,omitempty"`
}
Telephony contains telephony dial-in information for a meeting
type TelephonyLink ¶
type TelephonyLink struct {
GlobalCallinNumbers string `json:"globalCallinNumbers,omitempty"`
TelephonyTopic string `json:"telephonyTopic,omitempty"`
}
TelephonyLink contains global call-in URLs
type TelephonyLinks ¶ added in v2.0.12
type TelephonyLinks []TelephonyLink
TelephonyLinks represents the telephony links structure which can be either a single object or an array
type TrackingCode ¶ added in v2.0.12
type TrackingCode struct {
Name string `json:"name,omitempty"`
Value string `json:"value,omitempty"`
}
TrackingCode represents a tracking code for a meeting