subscribed_track

Documentation

Overview

Package subscribed_track contains auto-generated files. DO NOT MODIFY

Package subscribed_track contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchSubscribedTrackResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSubscribedTrackResponse, error)
• type ClientProperties
• type FetchSubscribedTrackResponse

Types

type Client

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

Client for managing a specific subscribed track resource 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 track client

func (Client) Fetch

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

Fetch retrieves a subscribed track resource See https://www.twilio.com/docs/video/api/track-subscriptions#get-st 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) (*FetchSubscribedTrackResponse, error)

FetchWithContext retrieves a subscribed track resource See https://www.twilio.com/docs/video/api/track-subscriptions#get-st for more details

type ClientProperties

type ClientProperties struct {
	ParticipantSid string
	RoomSid        string
	Sid            string
}

ClientProperties are the properties required to manage the subscribed track resources

type FetchSubscribedTrackResponse

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

FetchSubscribedTrackResponse defines the response fields for the retrieved subscribed track