Documentation ¶
Overview ¶
Package sync_streams contains auto-generated files. DO NOT MODIFY
Package sync_streams contains auto-generated files. DO NOT MODIFY
Package sync_streams contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c Client) Create(input *CreateSyncStreamInput) (*CreateSyncStreamResponse, error)
- func (c Client) CreateWithContext(context context.Context, input *CreateSyncStreamInput) (*CreateSyncStreamResponse, error)
- func (c *Client) NewSyncStreamsPaginator() *SyncStreamsPaginator
- func (c *Client) NewSyncStreamsPaginatorWithOptions(options *SyncStreamsPageOptions) *SyncStreamsPaginator
- func (c Client) Page(options *SyncStreamsPageOptions) (*SyncStreamsPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *SyncStreamsPageOptions) (*SyncStreamsPageResponse, error)
- type ClientProperties
- type CreateSyncStreamInput
- type CreateSyncStreamResponse
- type PageMetaResponse
- type PageSyncStreamResponse
- type SyncStreamsPage
- type SyncStreamsPageOptions
- type SyncStreamsPageResponse
- type SyncStreamsPaginator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for managing stream resources See https://www.twilio.com/docs/sync/api/stream-resource for more details
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the syncstreams client
func (Client) Create ¶
func (c Client) Create(input *CreateSyncStreamInput) (*CreateSyncStreamResponse, error)
Create creates a new stream See https://www.twilio.com/docs/sync/api/stream-resource#create-a-sync-stream-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 *CreateSyncStreamInput) (*CreateSyncStreamResponse, error)
CreateWithContext creates a new stream See https://www.twilio.com/docs/sync/api/stream-resource#create-a-sync-stream-resource for more details
func (*Client) NewSyncStreamsPaginator ¶
func (c *Client) NewSyncStreamsPaginator() *SyncStreamsPaginator
NewSyncStreamsPaginator creates a new instance of the paginator for Page.
func (*Client) NewSyncStreamsPaginatorWithOptions ¶
func (c *Client) NewSyncStreamsPaginatorWithOptions(options *SyncStreamsPageOptions) *SyncStreamsPaginator
NewSyncStreamsPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *SyncStreamsPageOptions) (*SyncStreamsPageResponse, error)
Page retrieves a page of streams See https://www.twilio.com/docs/sync/api/stream-resource#read-multiple-sync-stream-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 *SyncStreamsPageOptions) (*SyncStreamsPageResponse, error)
PageWithContext retrieves a page of streams See https://www.twilio.com/docs/sync/api/stream-resource#read-multiple-sync-stream-resources for more details
type ClientProperties ¶
type ClientProperties struct {
ServiceSid string
}
ClientProperties are the properties required to manage the syncstreams resources
type CreateSyncStreamInput ¶
type CreateSyncStreamInput struct { Ttl *int `form:"Ttl,omitempty"` UniqueName *string `form:"UniqueName,omitempty"` }
CreateSyncStreamInput defines the input fields for creating a new stream resource
type CreateSyncStreamResponse ¶
type CreateSyncStreamResponse struct { AccountSid string `json:"account_sid"` CreatedBy string `json:"created_by"` DateCreated time.Time `json:"date_created"` DateExpires *time.Time `json:"date_expires,omitempty"` DateUpdated *time.Time `json:"date_updated,omitempty"` ServiceSid string `json:"service_Sid"` Sid string `json:"sid"` URL string `json:"url"` UniqueName *string `json:"unique_name,omitempty"` }
CreateSyncStreamResponse defines the response fields for the created stream
type PageMetaResponse ¶
type PageSyncStreamResponse ¶
type PageSyncStreamResponse struct { AccountSid string `json:"account_sid"` CreatedBy string `json:"created_by"` DateCreated time.Time `json:"date_created"` DateExpires *time.Time `json:"date_expires,omitempty"` DateUpdated *time.Time `json:"date_updated,omitempty"` ServiceSid string `json:"service_Sid"` Sid string `json:"sid"` URL string `json:"url"` UniqueName *string `json:"unique_name,omitempty"` }
type SyncStreamsPage ¶
type SyncStreamsPage struct { CurrentPage *SyncStreamsPageResponse Error error // contains filtered or unexported fields }
SyncStreamsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageSyncStreamResponse or error that is returned from the api call(s)
type SyncStreamsPageOptions ¶
SyncStreamsPageOptions defines the query options for the api operation
type SyncStreamsPageResponse ¶
type SyncStreamsPageResponse struct { Meta PageMetaResponse `json:"meta"` SyncStreams []PageSyncStreamResponse `json:"streams"` }
SyncStreamsPageResponse defines the response fields for the streams page
type SyncStreamsPaginator ¶
type SyncStreamsPaginator struct { Page *SyncStreamsPage SyncStreams []PageSyncStreamResponse // contains filtered or unexported fields }
SyncStreamsPaginator defines the fields for makings paginated api calls SyncStreams is an array of syncstreams that have been returned from all of the page calls
func (*SyncStreamsPaginator) CurrentPage ¶
func (p *SyncStreamsPaginator) CurrentPage() *SyncStreamsPageResponse
CurrentPage retrieves the results for the current page
func (*SyncStreamsPaginator) Error ¶
func (p *SyncStreamsPaginator) Error() error
Error retrieves the error returned from the page
func (*SyncStreamsPaginator) Next ¶
func (p *SyncStreamsPaginator) 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 (*SyncStreamsPaginator) NextWithContext ¶
func (p *SyncStreamsPaginator) 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