composition_hooks

Documentation

Overview

Package composition_hooks contains auto-generated files. DO NOT MODIFY

Package composition_hooks contains auto-generated files. DO NOT MODIFY

Package composition_hooks contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateCompositionHookInput) (*CreateCompositionHookResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateCompositionHookInput) (*CreateCompositionHookResponse, error)
  • func (c *Client) NewCompositionHooksPaginator() *CompositionHooksPaginator
  • func (c *Client) NewCompositionHooksPaginatorWithOptions(options *CompositionHooksPageOptions) *CompositionHooksPaginator
  • func (c Client) Page(options *CompositionHooksPageOptions) (*CompositionHooksPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *CompositionHooksPageOptions) (*CompositionHooksPageResponse, error)
• type CompositionHooksPage
• type CompositionHooksPageOptions
• type CompositionHooksPageResponse
• type CompositionHooksPaginator
  • func (p *CompositionHooksPaginator) CurrentPage() *CompositionHooksPageResponse
  • func (p *CompositionHooksPaginator) Error() error
  • func (p *CompositionHooksPaginator) Next() bool
  • func (p *CompositionHooksPaginator) NextWithContext(context context.Context) bool
• type CreateCompositionHookInput
• type CreateCompositionHookResponse
• type PageCompositionHookResponse
• type PageMetaResponse

Types

type Client

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

Client for managing composition hook resources See https://www.twilio.com/docs/video/api/composition-hooks for more details

func New

func New(client *client.Client) *Client

New creates a new instance of the composition hooks client

func (Client) Create

func (c Client) Create(input *CreateCompositionHookInput) (*CreateCompositionHookResponse, error)

Create creates a new composition hook See https://www.twilio.com/docs/video/api/composition-hooks#hks-post for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateCompositionHookInput) (*CreateCompositionHookResponse, error)

CreateWithContext creates a new composition hook See https://www.twilio.com/docs/video/api/composition-hooks#hks-post for more details

func (*Client) NewCompositionHooksPaginator

func (c *Client) NewCompositionHooksPaginator() *CompositionHooksPaginator

NewCompositionHooksPaginator creates a new instance of the paginator for Page.

func (*Client) NewCompositionHooksPaginatorWithOptions

func (c *Client) NewCompositionHooksPaginatorWithOptions(options *CompositionHooksPageOptions) *CompositionHooksPaginator

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

func (Client) Page

func (c Client) Page(options *CompositionHooksPageOptions) (*CompositionHooksPageResponse, error)

Page retrieves a page of composition hooks See https://www.twilio.com/docs/video/api/composition-hooks#hks-get-parameters 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 *CompositionHooksPageOptions) (*CompositionHooksPageResponse, error)

PageWithContext retrieves a page of composition hooks See https://www.twilio.com/docs/video/api/composition-hooks#hks-get-parameters for more details

type CompositionHooksPage

type CompositionHooksPage struct {
	CurrentPage *CompositionHooksPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type CompositionHooksPageOptions

type CompositionHooksPageOptions struct {
	PageSize          *int
	Page              *int
	PageToken         *string
	Enabled           *bool
	FriendlyName      *string
	DateCreatedAfter  *string
	DateCreatedBefore *string
}

CompositionHooksPageOptions defines the query options for the api operation

type CompositionHooksPageResponse

type CompositionHooksPageResponse struct {
	CompositionHooks []PageCompositionHookResponse `json:"composition_hooks"`
	Meta             PageMetaResponse              `json:"meta"`
}

CompositionHooksPageResponse defines the response fields for the composition hooks page

type CompositionHooksPaginator

type CompositionHooksPaginator struct {
	Page             *CompositionHooksPage
	CompositionHooks []PageCompositionHookResponse
	// contains filtered or unexported fields
}

CompositionHooksPaginator defines the fields for makings paginated api calls CompositionHooks is an array of compositionhooks that have been returned from all of the page calls

func (*CompositionHooksPaginator) CurrentPage

func (p *CompositionHooksPaginator) CurrentPage() *CompositionHooksPageResponse

CurrentPage retrieves the results for the current page

func (*CompositionHooksPaginator) Error

func (p *CompositionHooksPaginator) Error() error

Error retrieves the error returned from the page

func (*CompositionHooksPaginator) Next

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

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

type CreateCompositionHookInput

type CreateCompositionHookInput struct {
	AudioSources         *[]string `form:"AudioSources,omitempty"`
	AudioSourcesExcluded *[]string `form:"AudioSourcesExcluded,omitempty"`
	Enabled              *bool     `form:"Enabled,omitempty"`
	Format               *string   `form:"Format,omitempty"`
	FriendlyName         string    `validate:"required" form:"FriendlyName"`
	Resolution           *string   `form:"Resolution,omitempty"`
	StatusCallback       *string   `form:"StatusCallback,omitempty"`
	StatusCallbackMethod *string   `form:"StatusCallbackMethod,omitempty"`
	Trim                 *bool     `form:"Trim,omitempty"`
	VideoLayout          *string   `form:"VideoLayout,omitempty"`
}

CreateCompositionHookInput defines the input fields for creating a new composition hook

type CreateCompositionHookResponse

type CreateCompositionHookResponse struct {
	AccountSid           string                 `json:"account_sid"`
	AudioSources         []string               `json:"audio_sources"`
	AudioSourcesExcluded []string               `json:"audio_sources_excluded"`
	DateCreated          time.Time              `json:"date_created"`
	DateUpdated          *time.Time             `json:"date_updated,omitempty"`
	Enabled              bool                   `json:"enabled"`
	Format               string                 `json:"format"`
	FriendlyName         string                 `json:"friendly_name"`
	Resolution           string                 `json:"resolution"`
	Sid                  string                 `json:"sid"`
	StatusCallback       *string                `json:"status_callback,omitempty"`
	StatusCallbackMethod string                 `json:"status_callback_method"`
	Trim                 bool                   `json:"trim"`
	URL                  string                 `json:"url"`
	VideoLayout          map[string]interface{} `json:"video_layout"`
}

CreateCompositionHookResponse defines the response fields for the created composition hook

type PageCompositionHookResponse

type PageCompositionHookResponse struct {
	AccountSid           string                 `json:"account_sid"`
	AudioSources         []string               `json:"audio_sources"`
	AudioSourcesExcluded []string               `json:"audio_sources_excluded"`
	DateCreated          time.Time              `json:"date_created"`
	DateUpdated          *time.Time             `json:"date_updated,omitempty"`
	Enabled              bool                   `json:"enabled"`
	Format               string                 `json:"format"`
	FriendlyName         string                 `json:"friendly_name"`
	Resolution           string                 `json:"resolution"`
	Sid                  string                 `json:"sid"`
	StatusCallback       *string                `json:"status_callback,omitempty"`
	StatusCallbackMethod string                 `json:"status_callback_method"`
	Trim                 bool                   `json:"trim"`
	URL                  string                 `json:"url"`
	VideoLayout          map[string]interface{} `json:"video_layout"`
}

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