subscribe_rules

Documentation

Overview

Package subscribe_rules contains auto-generated files. DO NOT MODIFY

Package subscribe_rules contains auto-generated files. DO NOT MODIFY

Package subscribe_rules contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchSubscribeRulesResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSubscribeRulesResponse, error)
  • func (c Client) Update(input *UpdateSubscribeRulesInput) (*UpdateSubscribeRulesResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSubscribeRulesInput) (*UpdateSubscribeRulesResponse, error)
• type ClientProperties
• type FetchSubscribeRuleResponse
• type FetchSubscribeRulesResponse
• type UpdateSubscribeRuleResponse
• type UpdateSubscribeRulesInput
• type UpdateSubscribeRulesResponse

Types

type Client

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

Client for managing a specific subscribe rules resource See https://www.twilio.com/docs/video/api/track-subscriptions#sl-resource for more details

func New

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

New creates a new instance of the subscribe rules client

func (Client) Fetch

func (c Client) Fetch() (*FetchSubscribeRulesResponse, error)

Fetch retrieves a subscribe rules resource See https://www.twilio.com/docs/video/api/track-subscriptions#sr-get for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchSubscribeRulesResponse, error)

FetchWithContext retrieves a subscribe rules resource See https://www.twilio.com/docs/video/api/track-subscriptions#sr-get for more details

func (Client) Update

func (c Client) Update(input *UpdateSubscribeRulesInput) (*UpdateSubscribeRulesResponse, error)

Update modifies a subscribe rules resource See https://www.twilio.com/docs/video/api/track-subscriptions#sr-post for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateSubscribeRulesInput) (*UpdateSubscribeRulesResponse, error)

UpdateWithContext modifies a subscribe rules resource See https://www.twilio.com/docs/video/api/track-subscriptions#sr-post for more details

type ClientProperties

type ClientProperties struct {
	ParticipantSid string
	RoomSid        string
}

ClientProperties are the properties required to manage the subscribe rules resources

type FetchSubscribeRuleResponse

type FetchSubscribeRuleResponse struct {
	All       *bool   `json:"all,omitempty"`
	Kind      *string `json:"kind,omitempty"`
	Priority  *string `json:"priority,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
	Track     *string `json:"track,omitempty"`
	Type      string  `json:"type"`
}

type FetchSubscribeRulesResponse

type FetchSubscribeRulesResponse struct {
	DateCreated    time.Time                    `json:"date_created"`
	DateUpdated    *time.Time                   `json:"date_updated,omitempty"`
	ParticipantSid string                       `json:"participant_sid"`
	RoomSid        string                       `json:"room_sid"`
	Rules          []FetchSubscribeRuleResponse `json:"rules"`
}

FetchSubscribeRulesResponse defines the response fields for the retrieved subscribe rules

type UpdateSubscribeRuleResponse

type UpdateSubscribeRuleResponse struct {
	All       *bool   `json:"all,omitempty"`
	Kind      *string `json:"kind,omitempty"`
	Priority  *string `json:"priority,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
	Track     *string `json:"track,omitempty"`
	Type      string  `json:"type"`
}

type UpdateSubscribeRulesInput

type UpdateSubscribeRulesInput struct {
	Rules string `validate:"required" form:"Rules"`
}

UpdateSubscribeRulesInput defines input fields for updating a subscribe rules resource

type UpdateSubscribeRulesResponse

type UpdateSubscribeRulesResponse struct {
	DateCreated    time.Time                     `json:"date_created"`
	DateUpdated    *time.Time                    `json:"date_updated,omitempty"`
	ParticipantSid string                        `json:"participant_sid"`
	RoomSid        string                        `json:"room_sid"`
	Rules          []UpdateSubscribeRuleResponse `json:"rules"`
}

UpdateSubscribeRulesResponse defines the response fields for the updated subscribe rules