published_tracks

Documentation

Overview

Package published_tracks contains auto-generated files. DO NOT MODIFY

Package published_tracks contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewPublishedTracksPaginator() *PublishedTracksPaginator
  • func (c *Client) NewPublishedTracksPaginatorWithOptions(options *PublishedTracksPageOptions) *PublishedTracksPaginator
  • func (c Client) Page(options *PublishedTracksPageOptions) (*PublishedTracksPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *PublishedTracksPageOptions) (*PublishedTracksPageResponse, error)
• type ClientProperties
• type PageMetaResponse
• type PagePublishedTrackResponse
• type PublishedTracksPage
• type PublishedTracksPageOptions
• type PublishedTracksPageResponse
• type PublishedTracksPaginator
  • func (p *PublishedTracksPaginator) CurrentPage() *PublishedTracksPageResponse
  • func (p *PublishedTracksPaginator) Error() error
  • func (p *PublishedTracksPaginator) Next() bool
  • func (p *PublishedTracksPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing published track resources See https://www.twilio.com/docs/video/api/track-subscriptions for more details

func New

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

New creates a new instance of the published tracks client

func (*Client) NewPublishedTracksPaginator

func (c *Client) NewPublishedTracksPaginator() *PublishedTracksPaginator

NewPublishedTracksPaginator creates a new instance of the paginator for Page.

func (*Client) NewPublishedTracksPaginatorWithOptions

func (c *Client) NewPublishedTracksPaginatorWithOptions(options *PublishedTracksPageOptions) *PublishedTracksPaginator

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

func (Client) Page

func (c Client) Page(options *PublishedTracksPageOptions) (*PublishedTracksPageResponse, error)

Page retrieves a page of published tracks See https://www.twilio.com/docs/video/api/track-subscriptions#get-stl 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 *PublishedTracksPageOptions) (*PublishedTracksPageResponse, error)

PageWithContext retrieves a page of published tracks See https://www.twilio.com/docs/video/api/track-subscriptions#get-stl for more details

type ClientProperties

type ClientProperties struct {
	ParticipantSid string
	RoomSid        string
}

ClientProperties are the properties required to manage the published tracks 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 PagePublishedTrackResponse

type PagePublishedTrackResponse struct {
	DateCreated    time.Time  `json:"date_created"`
	DateUpdated    *time.Time `json:"date_updated,omitempty"`
	Enabled        bool       `json:"enabled"`
	Kind           string     `json:"kind"`
	Name           string     `json:"name"`
	ParticipantSid string     `json:"participant_sid"`
	RoomSid        string     `json:"room_sid"`
	Sid            string     `json:"sid"`
	URL            string     `json:"url"`
}

type PublishedTracksPage

type PublishedTracksPage struct {
	CurrentPage *PublishedTracksPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type PublishedTracksPageOptions

type PublishedTracksPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

PublishedTracksPageOptions defines the query options for the api operation

type PublishedTracksPageResponse

type PublishedTracksPageResponse struct {
	Meta            PageMetaResponse             `json:"meta"`
	PublishedTracks []PagePublishedTrackResponse `json:"published_tracks"`
}

PublishedTracksPageResponse defines the response fields for the published track page

type PublishedTracksPaginator

type PublishedTracksPaginator struct {
	Page            *PublishedTracksPage
	PublishedTracks []PagePublishedTrackResponse
	// contains filtered or unexported fields
}

PublishedTracksPaginator defines the fields for makings paginated api calls PublishedTracks is an array of publishedtracks that have been returned from all of the page calls

func (*PublishedTracksPaginator) CurrentPage

func (p *PublishedTracksPaginator) CurrentPage() *PublishedTracksPageResponse

CurrentPage retrieves the results for the current page

func (*PublishedTracksPaginator) Error

func (p *PublishedTracksPaginator) Error() error

Error retrieves the error returned from the page

func (*PublishedTracksPaginator) Next

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

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