rooms

Documentation

Overview

Package rooms contains auto-generated files. DO NOT MODIFY

Package rooms contains auto-generated files. DO NOT MODIFY

Package rooms contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateRoomInput) (*CreateRoomResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateRoomInput) (*CreateRoomResponse, error)
  • func (c *Client) NewRoomsPaginator() *RoomsPaginator
  • func (c *Client) NewRoomsPaginatorWithOptions(options *RoomsPageOptions) *RoomsPaginator
  • func (c Client) Page(options *RoomsPageOptions) (*RoomsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *RoomsPageOptions) (*RoomsPageResponse, error)
• type CreateRoomInput
• type CreateRoomResponse
• type PageMetaResponse
• type PageRoomResponse
• type RoomsPage
• type RoomsPageOptions
• type RoomsPageResponse
• type RoomsPaginator
  • func (p *RoomsPaginator) CurrentPage() *RoomsPageResponse
  • func (p *RoomsPaginator) Error() error
  • func (p *RoomsPaginator) Next() bool
  • func (p *RoomsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

func New(client *client.Client) *Client

New creates a new instance of the rooms client

func (Client) Create

func (c Client) Create(input *CreateRoomInput) (*CreateRoomResponse, error)

Create creates a new room See https://www.twilio.com/docs/video/api/rooms-resource#create-room for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateRoomInput) (*CreateRoomResponse, error)

CreateWithContext creates a new room See https://www.twilio.com/docs/video/api/rooms-resource#create-room for more details

func (*Client) NewRoomsPaginator

func (c *Client) NewRoomsPaginator() *RoomsPaginator

NewRoomsPaginator creates a new instance of the paginator for Page.

func (*Client) NewRoomsPaginatorWithOptions

func (c *Client) NewRoomsPaginatorWithOptions(options *RoomsPageOptions) *RoomsPaginator

NewRoomsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *RoomsPageOptions) (*RoomsPageResponse, error)

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

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *RoomsPageOptions) (*RoomsPageResponse, error)

PageWithContext retrieves a page of rooms See https://www.twilio.com/docs/video/api/rooms-resource#get-list-resource for more details

type CreateRoomInput

type CreateRoomInput struct {
	MaxParticipants             *int      `form:"MaxParticipants,omitempty"`
	MediaRegion                 *string   `form:"MediaRegion,omitempty"`
	RecordParticipantsOnConnect *bool     `form:"RecordParticipantsOnConnect,omitempty"`
	StatusCallback              *string   `form:"StatusCallback,omitempty"`
	StatusCallbackMethod        *string   `form:"StatusCallbackMethod,omitempty"`
	Type                        *string   `form:"Type,omitempty"`
	UniqueName                  *string   `form:"UniqueName,omitempty"`
	VideoCodecs                 *[]string `form:"VideoCodecs,omitempty"`
}

CreateRoomInput defines the input fields for creating a new room

type CreateRoomResponse

type CreateRoomResponse 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"`
}

CreateRoomResponse defines the response fields for the created room

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}

type PageRoomResponse

type PageRoomResponse 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"`
}

type RoomsPage

type RoomsPage struct {
	CurrentPage *RoomsPageResponse
	Error       error
	// contains filtered or unexported fields
}

RoomsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageRoomResponse or error that is returned from the api call(s)

type RoomsPageOptions

type RoomsPageOptions struct {
	PageSize          *int
	Page              *int
	PageToken         *string
	Status            *string
	UniqueName        *string
	DateCreatedAfter  *string
	DateCreatedBefore *string
}

RoomsPageOptions defines the query options for the api operation

type RoomsPageResponse

type RoomsPageResponse struct {
	Meta  PageMetaResponse   `json:"meta"`
	Rooms []PageRoomResponse `json:"rooms"`
}

RoomsPageResponse defines the response fields for the rooms page

type RoomsPaginator

type RoomsPaginator struct {
	Page  *RoomsPage
	Rooms []PageRoomResponse
	// contains filtered or unexported fields
}

RoomsPaginator defines the fields for makings paginated api calls Rooms is an array of rooms that have been returned from all of the page calls

func (*RoomsPaginator) CurrentPage

func (p *RoomsPaginator) CurrentPage() *RoomsPageResponse

CurrentPage retrieves the results for the current page

func (*RoomsPaginator) Error

func (p *RoomsPaginator) Error() error

Error retrieves the error returned from the page

func (*RoomsPaginator) Next

func (p *RoomsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*RoomsPaginator) NextWithContext

func (p *RoomsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate