Documentation
¶
Index ¶
- Constants
- func IsError(err error, code string) bool
- type Client
- func (c *Client) CreateHook(ctx context.Context, req *requests.CreateHookRequest) (*responses.CreateHookResponse, error)
- func (c *Client) CreateMeeting(ctx context.Context, req *requests.CreateMeetingRequest) (*responses.CreateMeetingResponse, error)
- func (c *Client) DeleteRecordings(ctx context.Context, recordID string) (*responses.DeleteRecordingsResponse, error)
- func (c *Client) DestroyHook(ctx context.Context, hookID string) (*responses.DestroyHookResponse, error)
- func (c *Client) EndMeeting(ctx context.Context, req *requests.EndMeetingRequest) (*responses.EndMeetingResponse, error)
- func (c *Client) GetMeetingInfo(ctx context.Context, meetingID, password string) (*responses.GetMeetingInfoResponse, error)
- func (c *Client) GetMeetings(ctx context.Context) (*responses.GetMeetingsResponse, error)
- func (c *Client) GetRecordings(ctx context.Context, req *requests.GetRecordingsRequest) (*responses.GetRecordingsResponse, error)
- func (c *Client) IsMeetingRunning(ctx context.Context, meetingID string) (bool, error)
- func (c *Client) JoinMeeting(ctx context.Context, req *requests.JoinMeetingRequest) (string, error)
- func (c *Client) ListHooks(ctx context.Context) (*responses.HooksResponse, error)
- func (c *Client) ListHooksForMeeting(ctx context.Context, meetingID string) (*responses.HooksResponse, error)
- func (c *Client) PublishRecordings(ctx context.Context, req *requests.PublishRecordingsRequest) (*responses.PublishRecordingsResponse, error)
- func (c *Client) UpdateHook(ctx context.Context, hookID string, updates map[string]string) (*responses.CreateHookResponse, error)
- func (c *Client) UpdateRecordings(ctx context.Context, req *requests.UpdateRecordingsRequest) (*responses.UpdateRecordingsResponse, error)
- type Error
- type Option
Constants ¶
const ( // General errors ErrInvalidURL = "invalid_url" ErrInvalidResponse = "invalid_response" ErrRequestFailed = "request_failed" ErrNotFound = "not_found" ErrInternalServerError = "internal_server_error" // API specific errors ErrChecksumMismatch = "checksum_mismatch" ErrMissingParam = "missing_parameter" ErrInvalidParam = "invalid_parameter" )
Common error codes and messages.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a BigBlueButton API client.
func NewTestClient ¶
func NewTestClient(t *testing.T, handler http.HandlerFunc) *Client
NewTestClient creates a new test client with the provided handler.
func (*Client) CreateHook ¶
func (c *Client) CreateHook(ctx context.Context, req *requests.CreateHookRequest) (*responses.CreateHookResponse, error)
CreateHook creates a new webhook If MeetingID is empty, creates a permanent hook that receives all events
func (*Client) CreateMeeting ¶
func (c *Client) CreateMeeting(ctx context.Context, req *requests.CreateMeetingRequest) (*responses.CreateMeetingResponse, error)
CreateMeeting creates a new meeting with the specified parameters.
func (*Client) DeleteRecordings ¶
func (c *Client) DeleteRecordings(ctx context.Context, recordID string) (*responses.DeleteRecordingsResponse, error)
DeleteRecordings deletes a recording.
func (*Client) DestroyHook ¶
func (c *Client) DestroyHook(ctx context.Context, hookID string) (*responses.DestroyHookResponse, error)
DestroyHook removes a webhook
func (*Client) EndMeeting ¶
func (c *Client) EndMeeting(ctx context.Context, req *requests.EndMeetingRequest) (*responses.EndMeetingResponse, error)
EndMeeting ends a running meeting.
func (*Client) GetMeetingInfo ¶
func (c *Client) GetMeetingInfo(ctx context.Context, meetingID, password string) (*responses.GetMeetingInfoResponse, error)
GetMeetingInfo retrieves information about a specific meeting.
func (*Client) GetMeetings ¶
GetMeetings retrieves a list of all running meetings.
func (*Client) GetRecordings ¶
func (c *Client) GetRecordings(ctx context.Context, req *requests.GetRecordingsRequest) (*responses.GetRecordingsResponse, error)
GetRecordings retrieves recordings that are available for playback.
func (*Client) IsMeetingRunning ¶
IsMeetingRunning checks if a meeting is running.
func (*Client) JoinMeeting ¶
JoinMeeting generates a join URL for a meeting.
func (*Client) ListHooksForMeeting ¶
func (c *Client) ListHooksForMeeting(ctx context.Context, meetingID string) (*responses.HooksResponse, error)
ListHooksForMeeting retrieves all webhooks for a specific meeting
func (*Client) PublishRecordings ¶
func (c *Client) PublishRecordings(ctx context.Context, req *requests.PublishRecordingsRequest) (*responses.PublishRecordingsResponse, error)
PublishRecordings publishes or unpublishes a recording.
func (*Client) UpdateHook ¶
func (c *Client) UpdateHook(ctx context.Context, hookID string, updates map[string]string) (*responses.CreateHookResponse, error)
UpdateHook updates an existing webhook
func (*Client) UpdateRecordings ¶
func (c *Client) UpdateRecordings(ctx context.Context, req *requests.UpdateRecordingsRequest) (*responses.UpdateRecordingsResponse, error)
UpdateRecordings updates a recording's metadata.
type Error ¶
Error represents a BigBlueButton API error.
type Option ¶
Option configures a Client.
func WithHTTPClient ¶
WithHTTPClient sets the HTTP client for the BigBlueButton client.
func WithTimeout ¶
WithTimeout sets the timeout for the HTTP client.
Source Files
Directories