channel

Documentation

Overview

Package channel contains auto-generated files. DO NOT MODIFY

Package channel contains auto-generated files. DO NOT MODIFY

Package channel contains auto-generated files. DO NOT MODIFY

Package channel contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchChannelResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChannelResponse, error)
  • func (c Client) Update(input *UpdateChannelInput) (*UpdateChannelResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateChannelInput) (*UpdateChannelResponse, error)
• type ClientProperties
• type FetchChannelResponse
• type UpdateChannelInput
• type UpdateChannelResponse

Types

type Client

type Client struct {
	Invite   func(string) *invite.Client
	Invites  *invites.Client
	Member   func(string) *member.Client
	Members  *members.Client
	Message  func(string) *message.Client
	Messages *messages.Client
	Webhook  func(string) *webhook.Client
	Webhooks *webhooks.Client
	// contains filtered or unexported fields
}

Client for managing a specific channel resource See https://www.twilio.com/docs/chat/rest/channel-resource for more details

func New

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

New creates a new instance of the channel client

func (Client) Delete

func (c Client) Delete() error

Delete removes a channel resource from the account See https://www.twilio.com/docs/chat/rest/channel-resource#delete-a-channel-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a channel resource from the account See https://www.twilio.com/docs/chat/rest/channel-resource#delete-a-channel-resource for more details

func (Client) Fetch

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

Fetch retrieves a channel resource See https://www.twilio.com/docs/chat/rest/channel-resource#fetch-a-channel-resource 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) (*FetchChannelResponse, error)

FetchWithContext retrieves a channel resource See https://www.twilio.com/docs/chat/rest/channel-resource#fetch-a-channel-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateChannelInput) (*UpdateChannelResponse, error)

Update modifies a channel resource See https://www.twilio.com/docs/chat/rest/channel-resource#update-a-channel-resource 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 *UpdateChannelInput) (*UpdateChannelResponse, error)

UpdateWithContext modifies a channel resource See https://www.twilio.com/docs/chat/rest/channel-resource#update-a-channel-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the channel resources

type FetchChannelResponse

type FetchChannelResponse struct {
	AccountSid    string     `json:"account_sid"`
	Attributes    *string    `json:"attributes,omitempty"`
	CreatedBy     string     `json:"created_by"`
	DateCreated   time.Time  `json:"date_created"`
	DateUpdated   *time.Time `json:"date_updated,omitempty"`
	FriendlyName  *string    `json:"friendly_name,omitempty"`
	MembersCount  int        `json:"members_count"`
	MessagesCount int        `json:"messages_count"`
	ServiceSid    string     `json:"service_sid"`
	Sid           string     `json:"sid"`
	Type          string     `json:"type"`
	URL           string     `json:"url"`
	UniqueName    *string    `json:"unique_name,omitempty"`
}

FetchChannelResponse defines the response fields for the retrieved channel

type UpdateChannelInput

type UpdateChannelInput struct {
	Attributes   *string    `form:"Attributes,omitempty"`
	CreatedBy    *string    `form:"CreatedBy,omitempty"`
	DateCreated  *time.Time `form:"DateCreated,omitempty"`
	DateUpdated  *time.Time `form:"DateUpdated,omitempty"`
	FriendlyName *string    `form:"FriendlyName,omitempty"`
	UniqueName   *string    `form:"UniqueName,omitempty"`
}

UpdateChannelInput defines input fields for updating a channel resource

type UpdateChannelResponse

type UpdateChannelResponse struct {
	AccountSid    string     `json:"account_sid"`
	Attributes    *string    `json:"attributes,omitempty"`
	CreatedBy     string     `json:"created_by"`
	DateCreated   time.Time  `json:"date_created"`
	DateUpdated   *time.Time `json:"date_updated,omitempty"`
	FriendlyName  *string    `json:"friendly_name,omitempty"`
	MembersCount  int        `json:"members_count"`
	MessagesCount int        `json:"messages_count"`
	ServiceSid    string     `json:"service_sid"`
	Sid           string     `json:"sid"`
	Type          string     `json:"type"`
	URL           string     `json:"url"`
	UniqueName    *string    `json:"unique_name,omitempty"`
}

UpdateChannelResponse defines the response fields for the updated channel