Documentation
¶
Overview ¶
Package permissions contains auto-generated files. DO NOT MODIFY
Package permissions contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c *Client) NewSyncMapPermissionsPaginator() *SyncMapPermissionsPaginator
- func (c *Client) NewSyncMapPermissionsPaginatorWithOptions(options *SyncMapPermissionsPageOptions) *SyncMapPermissionsPaginator
- func (c Client) Page(options *SyncMapPermissionsPageOptions) (*SyncMapPermissionsPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *SyncMapPermissionsPageOptions) (*SyncMapPermissionsPageResponse, error)
- type ClientProperties
- type PageMetaResponse
- type PageSyncMapPermissionsResponse
- type SyncMapPermissionsPage
- type SyncMapPermissionsPageOptions
- type SyncMapPermissionsPageResponse
- type SyncMapPermissionsPaginator
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 map permission resources See https://www.twilio.com/docs/sync/api/sync-map-permission-resource for more details
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the permissions client
func (*Client) NewSyncMapPermissionsPaginator ¶
func (c *Client) NewSyncMapPermissionsPaginator() *SyncMapPermissionsPaginator
NewSyncMapPermissionsPaginator creates a new instance of the paginator for Page.
func (*Client) NewSyncMapPermissionsPaginatorWithOptions ¶
func (c *Client) NewSyncMapPermissionsPaginatorWithOptions(options *SyncMapPermissionsPageOptions) *SyncMapPermissionsPaginator
NewSyncMapPermissionsPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *SyncMapPermissionsPageOptions) (*SyncMapPermissionsPageResponse, error)
Page retrieves a page of map permissions See https://www.twilio.com/docs/sync/api/sync-map-permission-resource#read-multiple-sync-map-permission-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 *SyncMapPermissionsPageOptions) (*SyncMapPermissionsPageResponse, error)
PageWithContext retrieves a page of map permissions See https://www.twilio.com/docs/sync/api/sync-map-permission-resource#read-multiple-sync-map-permission-resources for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the permissions resources
type PageMetaResponse ¶
type SyncMapPermissionsPage ¶
type SyncMapPermissionsPage struct { CurrentPage *SyncMapPermissionsPageResponse Error error // contains filtered or unexported fields }
SyncMapPermissionsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageSyncMapPermissionsResponse or error that is returned from the api call(s)
type SyncMapPermissionsPageOptions ¶
SyncMapPermissionsPageOptions defines the query options for the api operation
type SyncMapPermissionsPageResponse ¶
type SyncMapPermissionsPageResponse struct { Meta PageMetaResponse `json:"meta"` Permissions []PageSyncMapPermissionsResponse `json:"permissions"` }
SyncMapPermissionsPageResponse defines the response fields for the map permissions page
type SyncMapPermissionsPaginator ¶
type SyncMapPermissionsPaginator struct { Page *SyncMapPermissionsPage Permissions []PageSyncMapPermissionsResponse // contains filtered or unexported fields }
SyncMapPermissionsPaginator defines the fields for makings paginated api calls Permissions is an array of permissions that have been returned from all of the page calls
func (*SyncMapPermissionsPaginator) CurrentPage ¶
func (p *SyncMapPermissionsPaginator) CurrentPage() *SyncMapPermissionsPageResponse
CurrentPage retrieves the results for the current page
func (*SyncMapPermissionsPaginator) Error ¶
func (p *SyncMapPermissionsPaginator) Error() error
Error retrieves the error returned from the page
func (*SyncMapPermissionsPaginator) Next ¶
func (p *SyncMapPermissionsPaginator) 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 (*SyncMapPermissionsPaginator) NextWithContext ¶
func (p *SyncMapPermissionsPaginator) 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