twitter

Documentation

Index

• func AddStreamRules(ctx context.Context, addRules []*gotwtr.AddRule) (*gotwtr.AddOrDeleteRulesResponse, error)
• func DeleteStreamRules(ctx context.Context, deleteRuleIDs []string) (*gotwtr.AddOrDeleteRulesResponse, error)
• func FetchStreamRules(ctx context.Context) (*gotwtr.RetrieveStreamRulesResponse, error)
• type ConnectToStreamOption
• type Stream
  • func NewStream(tweets chan<- *gotwtr.ConnectToStreamResponse, opt ...*ConnectToStreamOption) (*Stream, error)
  • func (s *Stream) Start(ctx context.Context) error
  • func (s *Stream) StartWithAutoReconnect(ctx context.Context) error
  • func (s *Stream) Stop()

Functions

func AddStreamRules

func AddStreamRules(ctx context.Context, addRules []*gotwtr.AddRule) (*gotwtr.AddOrDeleteRulesResponse, error)

func DeleteStreamRules

func DeleteStreamRules(ctx context.Context, deleteRuleIDs []string) (*gotwtr.AddOrDeleteRulesResponse, error)

func FetchStreamRules

func FetchStreamRules(ctx context.Context) (*gotwtr.RetrieveStreamRulesResponse, error)

Types

type ConnectToStreamOption

type ConnectToStreamOption struct {
	Expansions  []gotwtr.Expansion
	MediaFields []gotwtr.MediaField
	PlaceFields []gotwtr.PlaceField
	PollFields  []gotwtr.PollField
	TweetFields []gotwtr.TweetField
	UserFields  []gotwtr.UserField
}

type Stream

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

func NewStream

func NewStream(tweets chan<- *gotwtr.ConnectToStreamResponse, opt ...*ConnectToStreamOption) (*Stream, error)

func (*Stream) Start

func (s *Stream) Start(ctx context.Context) error

Start connects to stream, and blocks on success.

func (*Stream) StartWithAutoReconnect

func (s *Stream) StartWithAutoReconnect(ctx context.Context) error

StartWithAutoReconnect connects to stream, and reconnects to the stream as long as no errors are caught. Blocks on success.

func (*Stream) Stop

func (s *Stream) Stop()