chat

Documentation

Index

• Constants
• Variables
• func Export(ctx context.Context, c *telegram.Client, kvd kv.KV, opts ExportOptions) (rerr error)
• func ExportTypeNames() []string
• func List(ctx context.Context, c *telegram.Client, kvd kv.KV, opts ListOptions) error
• func ListOutputNames() []string
• func Users(ctx context.Context, c *telegram.Client, kvd kv.KV, opts UsersOptions) (rerr error)
• type Dialog
• type ExportOptions
• type ExportType
  • func ExportTypeValues() []ExportType
  • func ParseExportType(name string) (ExportType, error)
  • func (x *ExportType) Get() interface{}
  • func (x ExportType) IsValid() bool
  • func (x *ExportType) Set(val string) error
  • func (x ExportType) String() string
  • func (x *ExportType) Type() string
• type ListOptions
• type ListOutput
  • func ListOutputValues() []ListOutput
  • func ParseListOutput(name string) (ListOutput, error)
  • func (x *ListOutput) Get() interface{}
  • func (x ListOutput) IsValid() bool
  • func (x *ListOutput) Set(val string) error
  • func (x ListOutput) String() string
  • func (x *ListOutput) Type() string
• type Message
• type Topic
• type User
• type UsersOptions

Constants

const (
	DialogGroup   = "group"
	DialogPrivate = "private"
	DialogChannel = "channel"
	DialogUnknown = "unknown"
)

External designation, different from Telegram mtproto

Variables

var ErrInvalidExportType = fmt.Errorf("not a valid ExportType, try [%s]", strings.Join(_ExportTypeNames, ", "))

var ErrInvalidListOutput = fmt.Errorf("not a valid ListOutput, try [%s]", strings.Join(_ListOutputNames, ", "))

Functions

func Export

func Export(ctx context.Context, c *telegram.Client, kvd kv.KV, opts ExportOptions) (rerr error)

func ExportTypeNames

func ExportTypeNames() []string

ExportTypeNames returns a list of possible string values of ExportType.

func List

func List(ctx context.Context, c *telegram.Client, kvd kv.KV, opts ListOptions) error

func ListOutputNames

func ListOutputNames() []string

ListOutputNames returns a list of possible string values of ListOutput.

func Users

func Users(ctx context.Context, c *telegram.Client, kvd kv.KV, opts UsersOptions) (rerr error)

Types

type Dialog

type Dialog struct {
	ID          int64   `json:"id" comment:"ID of dialog"`
	Type        string  `json:"type" comment:"Type of dialog. Can be 'private', 'channel' or 'group'"`
	VisibleName string  `json:"visible_name,omitempty" comment:"Title of channel and group, first and last name of user. If empty, output '-'"`
	Username    string  `json:"username,omitempty" comment:"Username of dialog. If empty, output '-'"`
	Topics      []Topic `json:"topics,omitempty" comment:"Topics of dialog. If not set, output '-'"`
}

type ExportOptions

type ExportOptions struct {
	Type        ExportType
	Chat        string
	Thread      int // topic id in forum, message id in group
	Input       []int
	Output      string
	Filter      string
	OnlyMedia   bool
	WithContent bool
	Raw         bool
	All         bool
}

type ExportType

type ExportType int

ExportType ENUM(time, id, last)

const (
	// ExportTypeTime is a ExportType of type Time.
	ExportTypeTime ExportType = iota
	// ExportTypeId is a ExportType of type Id.
	ExportTypeId
	// ExportTypeLast is a ExportType of type Last.
	ExportTypeLast
)

func ExportTypeValues

func ExportTypeValues() []ExportType

ExportTypeValues returns a list of the values for ExportType

func ParseExportType

func ParseExportType(name string) (ExportType, error)

ParseExportType attempts to convert a string to a ExportType.

func (*ExportType) Get

func (x *ExportType) Get() interface{}

Get implements the Golang flag.Getter interface func.

func (ExportType) IsValid

func (x ExportType) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (*ExportType) Set

func (x *ExportType) Set(val string) error

Set implements the Golang flag.Value interface func.

func (ExportType) String

func (x ExportType) String() string

String implements the Stringer interface.

func (*ExportType) Type

func (x *ExportType) Type() string

Type implements the github.com/spf13/pFlag Value interface.

type ListOptions

type ListOptions struct {
	Output ListOutput
	Filter string
}

type ListOutput

type ListOutput int

ListOutput ENUM(table, json)

const (
	// ListOutputTable is a ListOutput of type Table.
	ListOutputTable ListOutput = iota
	// ListOutputJson is a ListOutput of type Json.
	ListOutputJson
)

func ListOutputValues

func ListOutputValues() []ListOutput

ListOutputValues returns a list of the values for ListOutput

func ParseListOutput

func ParseListOutput(name string) (ListOutput, error)

ParseListOutput attempts to convert a string to a ListOutput.

func (*ListOutput) Get

func (x *ListOutput) Get() interface{}

Get implements the Golang flag.Getter interface func.

func (ListOutput) IsValid

func (x ListOutput) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (*ListOutput) Set

func (x *ListOutput) Set(val string) error

Set implements the Golang flag.Value interface func.

func (ListOutput) String

func (x ListOutput) String() string

String implements the Stringer interface.

func (*ListOutput) Type

func (x *ListOutput) Type() string

Type implements the github.com/spf13/pFlag Value interface.

type Message

type Message struct {
	ID   int         `json:"id"`
	Type string      `json:"type"`
	File string      `json:"file"`
	Date int         `json:"date,omitempty"`
	Text string      `json:"text,omitempty"`
	Raw  *tg.Message `json:"raw,omitempty"`
}

type Topic

type Topic struct {
	ID    int    `json:"id" comment:"ID of topic"`
	Title string `json:"title" comment:"Title of topic"`
}

type User

type User struct {
	ID        int64  `json:"id"`
	Username  string `json:"username"`
	Phone     string `json:"phone"`
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
}

type UsersOptions

type UsersOptions struct {
	Chat   string
	Output string
	Raw    bool
}