discord

Documentation

Index

• Constants
• Variables
• func DownloadAsset(url string) ([]byte, string, error)
• func DownloadAvatarAsset(url string) ([]byte, error)
• type AssetCounter
  • func (c *AssetCounter) Increase()
  • func (c *AssetCounter) Value() uint64
• type Category
• type Channel
• type ErrorCodeType
• type ExportedData
• type ExtractedData
• type ImportError
  • func Error(message string) *ImportError
  • func Warning(message string) *ImportError
  • func (d ImportError) Error() string
• type ImportProgress
  • func (progress *ImportProgress) AddTaskError(task ImportTask, err *ImportError)
  • func (progress *ImportProgress) Init(totalChunkCount int, tasks []ImportTask)
  • func (progress *ImportProgress) Stop()
  • func (progress *ImportProgress) StopTask(task ImportTask)
  • func (progress *ImportProgress) UpdateTaskProgress(task ImportTask, value float32)
  • func (progress *ImportProgress) UpdateTaskState(task ImportTask, state ImportTaskState)
• type ImportTask
  • func (t ImportTask) String() string
• type ImportTaskProgress
• type ImportTaskState
  • func (t ImportTaskState) String() string
• type ImportTasks
• type MessageType

Constants

const MaxImportFileSizeBytes = 52428800

const MaxTaskErrorItemsCount = 3

Variables

var (
	ErrNoChannelData    = errors.New("No channels to import messages from")
	ErrNoMessageData    = errors.New("No messages to import")
	ErrMarshalMessage   = errors.New("Couldn't marshal discord message")
	ErrImportFileTooBig = fmt.Errorf("File is too big (max. %d MB)", MaxImportFileSizeBytes/1024/1024)
)

Functions

func DownloadAsset

func DownloadAsset(url string) ([]byte, string, error)

func DownloadAvatarAsset

func DownloadAvatarAsset(url string) ([]byte, error)

Types

type AssetCounter

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

func (*AssetCounter) Increase

func (c *AssetCounter) Increase()

func (*AssetCounter) Value

func (c *AssetCounter) Value() uint64

type Category

type Category struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type Channel

type Channel struct {
	ID           string `json:"id"`
	CategoryName string `json:"category"`
	CategoryID   string `json:"categoryId"`
	Name         string `json:"name"`
	Description  string `json:"topic"`
	FilePath     string `json:"filePath"`
}

type ErrorCodeType

type ErrorCodeType uint

const (
	NoErrorType ErrorCodeType = iota + 1
	WarningType
	ErrorType
)

type ExportedData

type ExportedData struct {
	Channel      Channel                    `json:"channel"`
	Messages     []*protobuf.DiscordMessage `json:"messages"`
	MessageCount int                        `json:"messageCount"`
}

type ExtractedData

type ExtractedData struct {
	Categories             map[string]*Category
	ExportedData           []*ExportedData
	OldestMessageTimestamp int
	MessageCount           int
}

type ImportError

type ImportError struct {
	// This code is used to distinguish between errors
	// that are considered "criticial" and those that are not.
	//
	// Critical errors are the ones that prevent the imported community
	// from functioning properly. For example, if the creation of the community
	// or its categories and channels fails, this is a critical error.
	//
	// Non-critical errors are the ones that would not prevent the imported
	// community from functioning. For example, if the channel data to be imported
	// has no messages, or is not parsable.
	Code     ErrorCodeType `json:"code"`
	Message  string        `json:"message"`
	TaskInfo string        `json:"taskInfo"`
}

func Error

func Error(message string) *ImportError

func Warning

func Warning(message string) *ImportError

func (ImportError) Error

func (d ImportError) Error() string

type ImportProgress

type ImportProgress struct {
	CommunityID     string                          `json:"communityId,omitempty"`
	CommunityName   string                          `json:"communityName"`
	CommunityImages map[string]images.IdentityImage `json:"communityImages"`
	Tasks           []*ImportTaskProgress           `json:"tasks"`
	Progress        float32                         `json:"progress"`
	ErrorsCount     uint                            `json:"errorsCount"`
	WarningsCount   uint                            `json:"warningsCount"`
	Stopped         bool                            `json:"stopped"`
	TotalChunkCount int                             `json:"totalChunksCount,omitempty"`
	CurrentChunk    int                             `json:"currentChunk,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportProgress) AddTaskError

func (progress *ImportProgress) AddTaskError(task ImportTask, err *ImportError)

func (*ImportProgress) Init

func (progress *ImportProgress) Init(totalChunkCount int, tasks []ImportTask)

func (*ImportProgress) Stop

func (progress *ImportProgress) Stop()

func (*ImportProgress) StopTask

func (progress *ImportProgress) StopTask(task ImportTask)

func (*ImportProgress) UpdateTaskProgress

func (progress *ImportProgress) UpdateTaskProgress(task ImportTask, value float32)

func (*ImportProgress) UpdateTaskState

func (progress *ImportProgress) UpdateTaskState(task ImportTask, state ImportTaskState)

type ImportTask

type ImportTask uint

const (
	CommunityCreationTask ImportTask = iota + 1
	ChannelsCreationTask
	ImportMessagesTask
	DownloadAssetsTask
	InitCommunityTask
)

func (ImportTask) String

func (t ImportTask) String() string

type ImportTaskProgress

type ImportTaskProgress struct {
	Type          string         `json:"type"`
	Progress      float32        `json:"progress"`
	Errors        []*ImportError `json:"errors"`
	Stopped       bool           `json:"stopped"`
	ErrorsCount   uint           `json:"errorsCount"`
	WarningsCount uint           `json:"warningsCount"`
	State         string         `json:"state"`
}

type ImportTaskState

type ImportTaskState uint

const (
	TaskStateInitialized ImportTaskState = iota
	TaskStateSaving
)

func (ImportTaskState) String

func (t ImportTaskState) String() string

type ImportTasks

type ImportTasks map[ImportTask]*ImportTaskProgress

type MessageType

type MessageType string

const (
	MessageTypeDefault       MessageType = "Default"
	MessageTypeReply         MessageType = "Reply"
	MessageTypeChannelPinned MessageType = "ChannelPinnedMessage"
)