participants

Documentation

Overview

Package participants contains auto-generated files. DO NOT MODIFY

Package participants contains auto-generated files. DO NOT MODIFY

Package participants contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateParticipantInput) (*CreateParticipantResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateParticipantInput) (*CreateParticipantResponse, error)
  • func (c *Client) NewParticipantsPaginator() *ParticipantsPaginator
  • func (c *Client) NewParticipantsPaginatorWithOptions(options *ParticipantsPageOptions) *ParticipantsPaginator
  • func (c Client) Page(options *ParticipantsPageOptions) (*ParticipantsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ParticipantsPageOptions) (*ParticipantsPageResponse, error)
• type ClientProperties
• type CreateParticipantInput
• type CreateParticipantResponse
• type PageMetaResponse
• type PageParticipantResponse
• type ParticipantsPage
• type ParticipantsPageOptions
• type ParticipantsPageResponse
• type ParticipantsPaginator
  • func (p *ParticipantsPaginator) CurrentPage() *ParticipantsPageResponse
  • func (p *ParticipantsPaginator) Error() error
  • func (p *ParticipantsPaginator) Next() bool
  • func (p *ParticipantsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

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

New creates a new instance of the participants client

func (Client) Create

func (c Client) Create(input *CreateParticipantInput) (*CreateParticipantResponse, error)

Create creates a new participant See https://www.twilio.com/docs/proxy/api/participant#create-a-participant-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 *CreateParticipantInput) (*CreateParticipantResponse, error)

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

func (*Client) NewParticipantsPaginator

func (c *Client) NewParticipantsPaginator() *ParticipantsPaginator

NewParticipantsPaginator creates a new instance of the paginator for Page.

func (*Client) NewParticipantsPaginatorWithOptions

func (c *Client) NewParticipantsPaginatorWithOptions(options *ParticipantsPageOptions) *ParticipantsPaginator

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

func (Client) Page

func (c Client) Page(options *ParticipantsPageOptions) (*ParticipantsPageResponse, error)

Page retrieves a page of participants See https://www.twilio.com/docs/proxy/api/participant#read-multiple-participant-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 *ParticipantsPageOptions) (*ParticipantsPageResponse, error)

PageWithContext retrieves a page of participants See https://www.twilio.com/docs/proxy/api/participant#read-multiple-participant-resources for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	SessionSid string
}

ClientProperties are the properties required to manage the participants resources

type CreateParticipantInput

type CreateParticipantInput struct {
	FriendlyName       *string `form:"FriendlyName,omitempty"`
	Identifier         string  `validate:"required" form:"Identifier"`
	ProxyIdentifier    *string `form:"ProxyIdentifier,omitempty"`
	ProxyIdentifierSid *string `form:"ProxyIdentifierSid,omitempty"`
}

CreateParticipantInput defines the input fields for creating a new participant resource

type CreateParticipantResponse

type CreateParticipantResponse struct {
	AccountSid         string     `json:"account_sid"`
	DateCreated        time.Time  `json:"date_created"`
	DateDeleted        *time.Time `json:"date_deleted,omitempty"`
	DateUpdated        *time.Time `json:"date_updated,omitempty"`
	FriendlyName       *string    `json:"friendly_name,omitempty"`
	Identifier         string     `json:"identifier"`
	ProxyIdentifier    *string    `json:"proxy_identifier,omitempty"`
	ProxyIdentifierSid *string    `json:"proxy_identifier_sid,omitempty"`
	ServiceSid         string     `json:"service_sid"`
	SessionSid         string     `json:"session_sid"`
	Sid                string     `json:"sid"`
	URL                string     `json:"url"`
}

CreateParticipantResponse defines the response fields for the created participant

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

type PageParticipantResponse

type PageParticipantResponse struct {
	AccountSid         string     `json:"account_sid"`
	DateCreated        time.Time  `json:"date_created"`
	DateDeleted        *time.Time `json:"date_deleted,omitempty"`
	DateUpdated        *time.Time `json:"date_updated,omitempty"`
	FriendlyName       *string    `json:"friendly_name,omitempty"`
	Identifier         string     `json:"identifier"`
	ProxyIdentifier    *string    `json:"proxy_identifier,omitempty"`
	ProxyIdentifierSid *string    `json:"proxy_identifier_sid,omitempty"`
	ServiceSid         string     `json:"service_sid"`
	SessionSid         string     `json:"session_sid"`
	Sid                string     `json:"sid"`
	URL                string     `json:"url"`
}

type ParticipantsPage

type ParticipantsPage struct {
	CurrentPage *ParticipantsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ParticipantsPageOptions

type ParticipantsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

ParticipantsPageOptions defines the query options for the api operation

type ParticipantsPageResponse

type ParticipantsPageResponse struct {
	Meta         PageMetaResponse          `json:"meta"`
	Participants []PageParticipantResponse `json:"participants"`
}

ParticipantsPageResponse defines the response fields for the participants page

type ParticipantsPaginator

type ParticipantsPaginator struct {
	Page         *ParticipantsPage
	Participants []PageParticipantResponse
	// contains filtered or unexported fields
}

ParticipantsPaginator defines the fields for makings paginated api calls Participants is an array of participants that have been returned from all of the page calls

func (*ParticipantsPaginator) CurrentPage

func (p *ParticipantsPaginator) CurrentPage() *ParticipantsPageResponse

CurrentPage retrieves the results for the current page

func (*ParticipantsPaginator) Error

func (p *ParticipantsPaginator) Error() error

Error retrieves the error returned from the page

func (*ParticipantsPaginator) Next

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

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