api

Documentation

Index

• Constants
• type ApiRequest
  • func NewRequest(url string, secret string, shatype SHA) (*ApiRequest, error)
  • func (api *ApiRequest) CreateMeeting(name string, meetingID string, attendeePW string, moderatorPW string, ...) (meeting, error)
  • func (api *ApiRequest) EndMeeting(meetingID string) (meeting, error)
  • func (api *ApiRequest) GetMeetings() (map[string]meeting, error)
  • func (api *ApiRequest) IsMeetingRunning(meetingID string) bool
  • func (api *ApiRequest) Join(meetingID string, userName string, moderator bool) (string, []*http.Cookie, string, string, string, string, error)
  • func (api *ApiRequest) JoinGetURL(meetingID string, userName string, moderator bool) (string, error)
• type SHA

Constants

const (
	CREATE             action = "create"
	END                action = "end"
	GET_MEETINGS       action = "getMeetings"
	IS_MEETING_RUNNING action = "isMeetingRunning"
	JOIN               action = "join"
)

const (
	MEETING_ID                 paramname = "meetingID"
	RECORD_ID                  paramname = "recordID"
	NAME                       paramname = "name"
	ATTENDEE_PW                paramname = "attendeePW"
	MODERATOR_PW               paramname = "moderatorPW"
	PASSWORD                   paramname = "password" //same as moderatorPW (I dont know why its sometimse called password and not moderatorPW)
	FULL_NAME                  paramname = "fullName"
	WELCOME                    paramname = "welcome"
	VOICE_BRIDGE               paramname = "voiceBridge"
	RECORD                     paramname = "record"
	AUTO_START_RECORDING       paramname = "autoStartRecording"
	ALLOW_START_STOP_RECORDING paramname = "allowStartStopRecording"
	DIAL_NUMBER                paramname = "dialNumber"
	WEB_VOICE                  paramname = "webVoice"
	LOGOUT_URL                 paramname = "logoutURL"
	MAX_PARTICIPANTS           paramname = "maxParticipants"
	DURATION                   paramname = "duration"
	USER_ID                    paramname = "userID"
	CREATE_TIME                paramname = "createTime"
	WEB_VOICE_CONF             paramname = "webVoiceConf"
	PUBLISH                    paramname = "publish"
	REDIRECT                   paramname = "redirect"
	CLIENT_URL                 paramname = "clientURL"
	CONFIG_TOKEN               paramname = "configToken"
	AVATAR_URL                 paramname = "avatarURL"
	MODERATOR_ONLY_MESSAGE     paramname = "moderatorOnlyMessage"
)

Types

type ApiRequest

type ApiRequest struct {
	// contains filtered or unexported fields
}

func NewRequest

func NewRequest(url string, secret string, shatype SHA) (*ApiRequest, error)

Create an object for making http get api requests to the BBB server. The requests are described here: https://bigbluebutton.org/api-mate/ and https://docs.bigbluebutton.org/dev/api.html

func (*ApiRequest) CreateMeeting

func (api *ApiRequest) CreateMeeting(name string, meetingID string, attendeePW string, moderatorPW string, welcome string, allowStartStopRecording bool, autoStartRecording bool, record bool, voiceBridge int64) (meeting, error)

Makes a http get request to the BigBlueButton API, creates a meeting and returns this new meeting

func (*ApiRequest) EndMeeting

func (api *ApiRequest) EndMeeting(meetingID string) (meeting, error)

Makes a http get request to the BigBlueButton API and returns the closed meeting

func (*ApiRequest) GetMeetings

func (api *ApiRequest) GetMeetings() (map[string]meeting, error)

Makes a http get request to the BigBlueButton API and returns a list of meetings

func (*ApiRequest) IsMeetingRunning

func (api *ApiRequest) IsMeetingRunning(meetingID string) bool

Makes a http get request to the BigBlueButton API and returs the running state of the meeting. If an error occurs the returned value is false

func (*ApiRequest) Join

func (api *ApiRequest) Join(meetingID string, userName string, moderator bool) (string, []*http.Cookie, string, string, string, string, error)

Makes a http get request to the BigBlueButton API to join a meeting and returs: - url - cookie - userid - auth_token - session_token - internal_meeting_id - error

func (*ApiRequest) JoinGetURL

func (api *ApiRequest) JoinGetURL(meetingID string, userName string, moderator bool) (string, error)

Makes a http get request to the BigBlueButton API to join a meeting and returs: - url

type SHA

type SHA string

const (
	SHA1   SHA = "SHA1"
	SHA256 SHA = "SHA256"
)