room

Documentation

Overview

Package room contains auto-generated files. DO NOT MODIFY

Package room contains auto-generated files. DO NOT MODIFY

Package room contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchRoomResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchRoomResponse, error)
  • func (c Client) Update(input *UpdateRoomInput) (*UpdateRoomResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateRoomInput) (*UpdateRoomResponse, error)
• type ClientProperties
• type FetchRoomResponse
• type UpdateRoomInput
• type UpdateRoomResponse

Types

type Client

type Client struct {
	Participant  func(string) *participant.Client
	Participants *participants.Client
	Recording    func(string) *recording.Client
	Recordings   *recordings.Client
	// contains filtered or unexported fields
}

Client for managing a specific room resource See https://www.twilio.com/docs/video/api/rooms-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the room client

func (Client) Fetch

func (c Client) Fetch() (*FetchRoomResponse, error)

Fetch retrieves a room resource See https://www.twilio.com/docs/video/api/rooms-resource#get-instance for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchRoomResponse, error)

FetchWithContext retrieves a room resource See https://www.twilio.com/docs/video/api/rooms-resource#get-instance for more details

func (Client) Update

func (c Client) Update(input *UpdateRoomInput) (*UpdateRoomResponse, error)

Update modifies a room resource See https://www.twilio.com/docs/video/api/rooms-resource#post-instance for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateRoomInput) (*UpdateRoomResponse, error)

UpdateWithContext modifies a room resource See https://www.twilio.com/docs/video/api/rooms-resource#post-instance for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the room resources

type FetchRoomResponse

type FetchRoomResponse struct {
	AccountSid                   string     `json:"account_sid"`
	DateCreated                  time.Time  `json:"date_created"`
	DateUpdated                  *time.Time `json:"date_updated,omitempty"`
	Duration                     *int       `json:"duration,omitempty"`
	EndTime                      *time.Time `json:"end_time,omitempty"`
	MaxConcurrentPublishedTracks *int       `json:"max_concurrent_published_tracks,omitempty"`
	MaxParticipants              int        `json:"max_participants"`
	MediaRegion                  *string    `json:"media_region,omitempty"`
	RecordParticipantsOnConnect  bool       `json:"record_participants_on_connect"`
	Sid                          string     `json:"sid"`
	Status                       string     `json:"status"`
	StatusCallback               *string    `json:"status_callback,omitempty"`
	StatusCallbackMethod         string     `json:"status_callback_method"`
	Type                         string     `json:"type"`
	URL                          string     `json:"url"`
	UniqueName                   string     `json:"unique_name"`
	VideoCodecs                  *[]string  `json:"video_codecs,omitempty"`
}

FetchRoomResponse defines the response fields for the retrieved room

type UpdateRoomInput

type UpdateRoomInput struct {
	Status string `validate:"required" form:"Status"`
}

UpdateRoomInput defines input fields for updating a room resource

type UpdateRoomResponse

type UpdateRoomResponse struct {
	AccountSid                   string     `json:"account_sid"`
	DateCreated                  time.Time  `json:"date_created"`
	DateUpdated                  *time.Time `json:"date_updated,omitempty"`
	Duration                     *int       `json:"duration,omitempty"`
	EndTime                      *time.Time `json:"end_time,omitempty"`
	MaxConcurrentPublishedTracks *int       `json:"max_concurrent_published_tracks,omitempty"`
	MaxParticipants              int        `json:"max_participants"`
	MediaRegion                  *string    `json:"media_region,omitempty"`
	RecordParticipantsOnConnect  bool       `json:"record_participants_on_connect"`
	Sid                          string     `json:"sid"`
	Status                       string     `json:"status"`
	StatusCallback               *string    `json:"status_callback,omitempty"`
	StatusCallbackMethod         string     `json:"status_callback_method"`
	Type                         string     `json:"type"`
	URL                          string     `json:"url"`
	UniqueName                   string     `json:"unique_name"`
	VideoCodecs                  *[]string  `json:"video_codecs,omitempty"`
}

UpdateRoomResponse defines the response fields for the updated room