conferences

Documentation

Overview

Package conferences contains auto-generated files. DO NOT MODIFY

Package conferences contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c *Client) NewConferencesPaginator() *ConferencesPaginator
  • func (c *Client) NewConferencesPaginatorWithOptions(options *ConferencesPageOptions) *ConferencesPaginator
  • func (c Client) Page(options *ConferencesPageOptions) (*ConferencesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ConferencesPageOptions) (*ConferencesPageResponse, error)
• type ClientProperties
• type ConferencesPage
• type ConferencesPageOptions
• type ConferencesPageResponse
• type ConferencesPaginator
  • func (p *ConferencesPaginator) CurrentPage() *ConferencesPageResponse
  • func (p *ConferencesPaginator) Error() error
  • func (p *ConferencesPaginator) Next() bool
  • func (p *ConferencesPaginator) NextWithContext(context context.Context) bool
• type PageConferenceResponse

Types

type Client

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

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

func New

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

New creates a new instance of the conferences client

func (*Client) NewConferencesPaginator

func (c *Client) NewConferencesPaginator() *ConferencesPaginator

NewConferencesPaginator creates a new instance of the paginator for Page.

func (*Client) NewConferencesPaginatorWithOptions

func (c *Client) NewConferencesPaginatorWithOptions(options *ConferencesPageOptions) *ConferencesPaginator

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

func (Client) Page

func (c Client) Page(options *ConferencesPageOptions) (*ConferencesPageResponse, error)

Page retrieves a page of conferences See https://www.twilio.com/docs/voice/api/conference-resource#read-multiple-conference-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 *ConferencesPageOptions) (*ConferencesPageResponse, error)

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

type ClientProperties

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the conferences resources

type ConferencesPage

type ConferencesPage struct {
	CurrentPage *ConferencesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ConferencesPageOptions

type ConferencesPageOptions struct {
	PageSize     *int
	Page         *int
	PageToken    *string
	FriendlyName *string
	Status       *string
	DateCreated  *string
	DateUpdated  *string
}

ConferencesPageOptions defines the query options for the api operation

type ConferencesPageResponse

type ConferencesPageResponse struct {
	Conferences     []PageConferenceResponse `json:"conferences"`
	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"`
	Start           int                      `json:"start"`
	URI             string                   `json:"uri"`
}

ConferencesPageResponse defines the response fields for the conferences page

type ConferencesPaginator

type ConferencesPaginator struct {
	Page        *ConferencesPage
	Conferences []PageConferenceResponse
	// contains filtered or unexported fields
}

ConferencesPaginator defines the fields for makings paginated api calls Conferences is an array of conferences that have been returned from all of the page calls

func (*ConferencesPaginator) CurrentPage

func (p *ConferencesPaginator) CurrentPage() *ConferencesPageResponse

CurrentPage retrieves the results for the current page

func (*ConferencesPaginator) Error

func (p *ConferencesPaginator) Error() error

Error retrieves the error returned from the page

func (*ConferencesPaginator) Next

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

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

type PageConferenceResponse struct {
	APIVersion              string             `json:"api_version"`
	AccountSid              string             `json:"account_sid"`
	CallSidEndingConference *string            `json:"call_sid_ending_conference,omitempty"`
	DateCreated             utils.RFC2822Time  `json:"date_created"`
	DateUpdated             *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName            string             `json:"friendly_name"`
	ReasonConferenceEnded   *string            `json:"reason_conference_ended,omitempty"`
	Region                  string             `json:"region"`
	Sid                     string             `json:"sid"`
	Status                  string             `json:"status"`
}