recordings

Documentation

Overview

Package recordings contains auto-generated files. DO NOT MODIFY

Package recordings contains auto-generated files. DO NOT MODIFY

Package recordings contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateRecordingInput) (*CreateRecordingResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateRecordingInput) (*CreateRecordingResponse, error)
  • func (c *Client) NewRecordingsPaginator() *RecordingsPaginator
  • func (c *Client) NewRecordingsPaginatorWithOptions(options *RecordingsPageOptions) *RecordingsPaginator
  • func (c Client) Page(options *RecordingsPageOptions) (*RecordingsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *RecordingsPageOptions) (*RecordingsPageResponse, error)
• type ClientProperties
• type CreateRecordingInput
• type CreateRecordingResponse
• type PageRecordingResponse
• type RecordingsPage
• type RecordingsPageOptions
• type RecordingsPageResponse
• type RecordingsPaginator
  • func (p *RecordingsPaginator) CurrentPage() *RecordingsPageResponse
  • func (p *RecordingsPaginator) Error() error
  • func (p *RecordingsPaginator) Next() bool
  • func (p *RecordingsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing recording resources See https://www.twilio.com/docs/voice/api/recording for more details

func New

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

New creates a new instance of the recordings client

func (Client) Create

func (c Client) Create(input *CreateRecordingInput) (*CreateRecordingResponse, error)

Create creates a new recording resource See https://www.twilio.com/docs/voice/api/recording#create-a-recording-resource 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 *CreateRecordingInput) (*CreateRecordingResponse, error)

CreateWithContext creates a new recording resource See https://www.twilio.com/docs/voice/api/recording#create-a-recording-resource for more details

func (*Client) NewRecordingsPaginator

func (c *Client) NewRecordingsPaginator() *RecordingsPaginator

NewRecordingsPaginator creates a new instance of the paginator for Page.

func (*Client) NewRecordingsPaginatorWithOptions

func (c *Client) NewRecordingsPaginatorWithOptions(options *RecordingsPageOptions) *RecordingsPaginator

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

func (Client) Page

func (c Client) Page(options *RecordingsPageOptions) (*RecordingsPageResponse, error)

Page retrieves a page of recordings See https://www.twilio.com/docs/voice/api/recording#read-multiple-recording-resources 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 *RecordingsPageOptions) (*RecordingsPageResponse, error)

PageWithContext retrieves a page of recordings See https://www.twilio.com/docs/voice/api/recording#read-multiple-recording-resources for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
	CallSid    string
}

ClientProperties are the properties required to manage the recordings resources

type CreateRecordingInput

type CreateRecordingInput struct {
	RecordingChannels             *string   `form:"RecordingChannels,omitempty"`
	RecordingStatusCallback       *string   `form:"RecordingStatusCallback,omitempty"`
	RecordingStatusCallbackEvents *[]string `form:"RecordingStatusCallbackEvent,omitempty"`
	RecordingStatusCallbackMethod *string   `form:"RecordingStatusCallbackMethod,omitempty"`
	RecordingTrack                *string   `form:"RecordingTrack,omitempty"`
	Trim                          *string   `form:"Trim,omitempty"`
}

CreateRecordingInput defines input fields for creating a new recording

type CreateRecordingResponse

type CreateRecordingResponse struct {
	APIVersion        string                  `json:"api_version"`
	CallSid           string                  `json:"call_sid"`
	Channels          int                     `json:"channels"`
	ConferenceSid     *string                 `json:"conference_sid,omitempty"`
	DateCreated       utils.RFC2822Time       `json:"date_created"`
	DateUpdated       *utils.RFC2822Time      `json:"date_updated,omitempty"`
	Duration          *string                 `json:"duration,omitempty"`
	EncryptionDetails *map[string]interface{} `json:"encryption_details,omitempty"`
	ErrorCode         *string                 `json:"error_code,omitempty"`
	Price             *string                 `json:"price,omitempty"`
	PriceUnit         *string                 `json:"price_unit,omitempty"`
	Sid               string                  `json:"sid"`
	Source            string                  `json:"source"`
	StartTime         utils.RFC2822Time       `json:"start_time"`
	Status            string                  `json:"status"`
}

CreateRecordingResponse defines the response fields for creating a new recording resource

type PageRecordingResponse

type PageRecordingResponse struct {
	APIVersion        string                  `json:"api_version"`
	CallSid           string                  `json:"call_sid"`
	Channels          int                     `json:"channels"`
	ConferenceSid     *string                 `json:"conference_sid,omitempty"`
	DateCreated       utils.RFC2822Time       `json:"date_created"`
	DateUpdated       *utils.RFC2822Time      `json:"date_updated,omitempty"`
	Duration          *string                 `json:"duration,omitempty"`
	EncryptionDetails *map[string]interface{} `json:"encryption_details,omitempty"`
	ErrorCode         *string                 `json:"error_code,omitempty"`
	Price             *string                 `json:"price,omitempty"`
	PriceUnit         *string                 `json:"price_unit,omitempty"`
	Sid               string                  `json:"sid"`
	Source            string                  `json:"source"`
	StartTime         utils.RFC2822Time       `json:"start_time"`
	Status            string                  `json:"status"`
}

type RecordingsPage

type RecordingsPage struct {
	CurrentPage *RecordingsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type RecordingsPageOptions

type RecordingsPageOptions struct {
	PageSize      *int
	Page          *int
	PageToken     *string
	DateCreated   *string
	CallSid       *string
	ConferenceSid *string
}

RecordingsPageOptions defines the query options for the api operation

type RecordingsPageResponse

type RecordingsPageResponse struct {
	End             int                     `json:"end"`
	FirstPageURI    string                  `json:"first_page_uri"`
	NextPageURI     *string                 `json:"next_page_uri,omitempty"`
	Page            int                     `json:"page"`
	PageSize        int                     `json:"page_size"`
	PreviousPageURI *string                 `json:"previous_page_uri,omitempty"`
	Recordings      []PageRecordingResponse `json:"recordings"`
	Start           int                     `json:"start"`
	URI             string                  `json:"uri"`
}

RecordingsPageResponse defines the response fields for the recordings page

type RecordingsPaginator

type RecordingsPaginator struct {
	Page       *RecordingsPage
	Recordings []PageRecordingResponse
	// contains filtered or unexported fields
}

RecordingsPaginator defines the fields for makings paginated api calls Recordings is an array of recordings that have been returned from all of the page calls

func (*RecordingsPaginator) CurrentPage

func (p *RecordingsPaginator) CurrentPage() *RecordingsPageResponse

CurrentPage retrieves the results for the current page

func (*RecordingsPaginator) Error

func (p *RecordingsPaginator) Error() error

Error retrieves the error returned from the page

func (*RecordingsPaginator) Next

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

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