subscribed_tracks

Documentation

Overview

Package subscribed_tracks contains auto-generated files. DO NOT MODIFY

Package subscribed_tracks contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewSubscribedTracksPaginator() *SubscribedTracksPaginator
  • func (c *Client) NewSubscribedTracksPaginatorWithOptions(options *SubscribedTracksPageOptions) *SubscribedTracksPaginator
  • func (c Client) Page(options *SubscribedTracksPageOptions) (*SubscribedTracksPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *SubscribedTracksPageOptions) (*SubscribedTracksPageResponse, error)
• type ClientProperties
• type PageMetaResponse
• type PageSubscribedTrackResponse
• type SubscribedTracksPage
• type SubscribedTracksPageOptions
• type SubscribedTracksPageResponse
• type SubscribedTracksPaginator
  • func (p *SubscribedTracksPaginator) CurrentPage() *SubscribedTracksPageResponse
  • func (p *SubscribedTracksPaginator) Error() error
  • func (p *SubscribedTracksPaginator) Next() bool
  • func (p *SubscribedTracksPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

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

New creates a new instance of the subscribed tracks client

func (*Client) NewSubscribedTracksPaginator

func (c *Client) NewSubscribedTracksPaginator() *SubscribedTracksPaginator

NewSubscribedTracksPaginator creates a new instance of the paginator for Page.

func (*Client) NewSubscribedTracksPaginatorWithOptions

func (c *Client) NewSubscribedTracksPaginatorWithOptions(options *SubscribedTracksPageOptions) *SubscribedTracksPaginator

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

func (Client) Page

func (c Client) Page(options *SubscribedTracksPageOptions) (*SubscribedTracksPageResponse, error)

Page retrieves a page of subscribed 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 *SubscribedTracksPageOptions) (*SubscribedTracksPageResponse, error)

PageWithContext retrieves a page of subscribed 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 subscribed 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 PageSubscribedTrackResponse

type PageSubscribedTrackResponse 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"`
	PublisherSid   string     `json:"publisher_sid"`
	RoomSid        string     `json:"room_sid"`
	Sid            string     `json:"sid"`
	URL            string     `json:"url"`
}

type SubscribedTracksPage

type SubscribedTracksPage struct {
	CurrentPage *SubscribedTracksPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type SubscribedTracksPageOptions

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

SubscribedTracksPageOptions defines the query options for the api operation

type SubscribedTracksPageResponse

type SubscribedTracksPageResponse struct {
	Meta             PageMetaResponse              `json:"meta"`
	SubscribedTracks []PageSubscribedTrackResponse `json:"subscribed_tracks"`
}

SubscribedTracksPageResponse defines the response fields for the subscribed track page

type SubscribedTracksPaginator

type SubscribedTracksPaginator struct {
	Page             *SubscribedTracksPage
	SubscribedTracks []PageSubscribedTrackResponse
	// contains filtered or unexported fields
}

SubscribedTracksPaginator defines the fields for makings paginated api calls SubscribedTracks is an array of subscribedtracks that have been returned from all of the page calls

func (*SubscribedTracksPaginator) CurrentPage

func (p *SubscribedTracksPaginator) CurrentPage() *SubscribedTracksPageResponse

CurrentPage retrieves the results for the current page

func (*SubscribedTracksPaginator) Error

func (p *SubscribedTracksPaginator) Error() error

Error retrieves the error returned from the page

func (*SubscribedTracksPaginator) Next

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

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