participant

Documentation

Overview

Package participant contains auto-generated files. DO NOT MODIFY

Package participant contains auto-generated files. DO NOT MODIFY

Package participant contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchParticipantResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchParticipantResponse, error)
  • func (c Client) Update(input *UpdateParticipantInput) (*UpdateParticipantResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateParticipantInput) (*UpdateParticipantResponse, error)
• type ClientProperties
• type FetchParticipantResponse
• type UpdateParticipantInput
• type UpdateParticipantResponse

Types

type Client

type Client struct {
	PublishedTrack   func(string) *published_track.Client
	PublishedTracks  *published_tracks.Client
	SubscribeRules   func() *subscribe_rules.Client
	SubscribedTrack  func(string) *subscribed_track.Client
	SubscribedTracks *subscribed_tracks.Client
	// contains filtered or unexported fields
}

Client for managing a specific participant resource See https://www.twilio.com/docs/video/api/participants for more details

func New

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

New creates a new instance of the participant client

func (Client) Fetch

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

Fetch retrieves a participant resource See https://www.twilio.com/docs/video/api/participants#http-get-1 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) (*FetchParticipantResponse, error)

FetchWithContext retrieves a participant resource See https://www.twilio.com/docs/video/api/participants#http-get-1 for more details

func (Client) Update

func (c Client) Update(input *UpdateParticipantInput) (*UpdateParticipantResponse, error)

Update modifies a participant resource See https://www.twilio.com/docs/video/api/participants#http-post for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateParticipantInput) (*UpdateParticipantResponse, error)

UpdateWithContext modifies a participant resource See https://www.twilio.com/docs/video/api/participants#http-post for more details

type ClientProperties

type ClientProperties struct {
	RoomSid string
	Sid     string
}

ClientProperties are the properties required to manage the participant resources

type FetchParticipantResponse

type FetchParticipantResponse 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"`
	Identity    string     `json:"identity"`
	RoomSid     string     `json:"room_sid"`
	Sid         string     `json:"sid"`
	StartTime   time.Time  `json:"start_time"`
	Status      string     `json:"status"`
	URL         string     `json:"url"`
}

FetchParticipantResponse defines the response fields for the retrieved participant

type UpdateParticipantInput

type UpdateParticipantInput struct {
	Status *string `form:"Status,omitempty"`
}

UpdateParticipantInput defines input fields for updating a participant resource

type UpdateParticipantResponse

type UpdateParticipantResponse 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"`
	Identity    string     `json:"identity"`
	RoomSid     string     `json:"room_sid"`
	Sid         string     `json:"sid"`
	StartTime   time.Time  `json:"start_time"`
	Status      string     `json:"status"`
	URL         string     `json:"url"`
}

UpdateParticipantResponse defines the response fields for the updated participant