recordings

Documentation

Overview

Package recordings contains auto-generated files. DO NOT MODIFY

Package recordings contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewRecordingsPaginator() *RecordingsPaginator
  • func (c *Client) NewRecordingsPaginatorWithOptions(options *RecordingsPageOptions) *RecordingsPaginator
  • func (c Client) Page(options *RecordingsPageOptions) (*RecordingsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *RecordingsPageOptions) (*RecordingsPageResponse, error)
• type ClientProperties
• type PageMetaResponse
• type PageRecordingGroupingSidsResponse
• type PageRecordingResponse
• type RecordingsPage
• type RecordingsPageOptions
• type RecordingsPageResponse
• type RecordingsPaginator
  • func (p *RecordingsPaginator) CurrentPage() *RecordingsPageResponse
  • func (p *RecordingsPaginator) Error() error
  • func (p *RecordingsPaginator) Next() bool
  • func (p *RecordingsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

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

New creates a new instance of the recordings client

func (*Client) NewRecordingsPaginator

func (c *Client) NewRecordingsPaginator() *RecordingsPaginator

NewRecordingsPaginator creates a new instance of the paginator for Page.

func (*Client) NewRecordingsPaginatorWithOptions

func (c *Client) NewRecordingsPaginatorWithOptions(options *RecordingsPageOptions) *RecordingsPaginator

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

func (Client) Page

func (c Client) Page(options *RecordingsPageOptions) (*RecordingsPageResponse, error)

Page retrieves a page of recordings See https://www.twilio.com/docs/video/api/recordings-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 *RecordingsPageOptions) (*RecordingsPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	RoomSid string
}

ClientProperties are the properties required to manage the recordings resources

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 PageRecordingGroupingSidsResponse

type PageRecordingGroupingSidsResponse struct {
	ParticipantSid string `json:"participant_sid"`
	RoomSid        string `json:"room_sid"`
}

type PageRecordingResponse

type PageRecordingResponse struct {
	AccountSid      string                            `json:"account_sid"`
	Codec           string                            `json:"codec"`
	ContainerFormat string                            `json:"container_format"`
	DateCreated     time.Time                         `json:"date_created"`
	Duration        int                               `json:"duration"`
	GroupingSids    PageRecordingGroupingSidsResponse `json:"grouping_sids"`
	Offset          int                               `json:"offset"`
	RoomSid         string                            `json:"room_sid"`
	Sid             string                            `json:"sid"`
	Size            int                               `json:"size"`
	SourceSid       string                            `json:"source_sid"`
	Status          string                            `json:"status"`
	TrackName       string                            `json:"track_name"`
	Type            string                            `json:"type"`
	URL             string                            `json:"url"`
}

type RecordingsPage

type RecordingsPage struct {
	CurrentPage *RecordingsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type RecordingsPageOptions

type RecordingsPageOptions struct {
	PageSize          *int
	Page              *int
	PageToken         *string
	Status            *string
	SourceSid         *string
	GroupingSid       *string
	MediaType         *string
	DateCreatedAfter  *time.Time
	DateCreatedBefore *time.Time
}

RecordingsPageOptions defines the query options for the api operation

type RecordingsPageResponse

type RecordingsPageResponse struct {
	Meta       PageMetaResponse        `json:"meta"`
	Recordings []PageRecordingResponse `json:"recordings"`
}

RecordingsPageResponse defines the response fields for the recordings page

type RecordingsPaginator

type RecordingsPaginator struct {
	Page       *RecordingsPage
	Recordings []PageRecordingResponse
	// contains filtered or unexported fields
}

RecordingsPaginator defines the fields for makings paginated api calls Recordings is an array of recordings that have been returned from all of the page calls

func (*RecordingsPaginator) CurrentPage

func (p *RecordingsPaginator) CurrentPage() *RecordingsPageResponse

CurrentPage retrieves the results for the current page

func (*RecordingsPaginator) Error

func (p *RecordingsPaginator) Error() error

Error retrieves the error returned from the page

func (*RecordingsPaginator) Next

func (p *RecordingsPaginator) 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 (*RecordingsPaginator) NextWithContext

func (p *RecordingsPaginator) 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